Skip to content
Connect API Catalog/
/
/
Update Profile Note By No...

Update Profile Note By Note Id

Request

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

Security
bearerToken
Path
profileIdstring, (uuid)required

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
noteIdstring, (uuid)required

Id of a note.

Example:047ae398-7639-40af-911e-cc214cf3045c
Headers
X-Team-Idstring, (uuid)

Optional. The team to work in, using a team id from List Teams. If left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team being deleted, is rejected with 404 Team Not Found.

Example:6b78aed4-9ba6-441b-80b9-df9bea3b7c97
Bodyapplication/json

The new text of the note, and whether it is archived.

bodystring or null

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

Example:"testing"
isArchivedboolean

Value indicating whether the note is archived.

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' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97' \
  -d '{
    "body": "Contract test note (edited)",
    "isArchived": true
  }'

Responses

Success

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

linkedTostring or null

The profile component the note is linked to. Available values are profile and profileDetails.

Enum:"profile""profileDetails"null
correlationIdstring

A unique ID assigned to this request.

Response
{
  "linkedTo": "profile",
  "id": "ebafd03a-3bdb-4b15-a858-351ae60fd223",
  "body": "Contract test note (edited)",
  "isArchived": false,
  "createdAt": "2026-11-03T14:40:08.058Z",
  "createdById": 100000001,
  "createdBy": "Jane Smith",
  "modifiedAt": "2026-11-03T14:40:08.512Z",
  "modifiedById": 100000001,
  "modifiedBy": "Jane Smith",
  "correlationId": "3f86628b-5cb0-4965-9552-46a9e4890172"
}