Update Profile Note By Note Id

Request

Updates a profile note based on profile id and note id.

Security

bearerToken

Path

profileIdstringrequired

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

noteIdstringrequired

Id of a note.

Example:047ae398-7639-40af-911e-cc214cf3045c

Bodyapplication/json

bodystring or null

The body of the note to be added. Limited to 1000 characters

Example:"testing"

isArchivedboolean

Example:true

curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes/047ae398-7639-40af-911e-cc214cf3045c \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "testing",
    "isArchived": true
  }'

Responses

Bodyapplication/json

idstring, (uuid)

Id of the note

bodystring

Body of the note

isArchivedboolean

Value indicating whether the note is archived

createdAtstring, (date-time)

Note created time

createdByIdinteger, (int32)

Id of the user who created note

createdBystring

Name of the user who created note

modifiedAtstring, (date-time)

Note last updated time

modifiedByIdinteger, (int32)

Id of the user who last modified the note

modifiedBystring

Name of the user who last modified the note

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "body": "string",
  "isArchived": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string"
}