Sign in
Notes

Update note by ID

Updates a note based on the unique note ID.

Any one of the following roles is required for this endpoint:

Legacy RoleEquivalent Permission Set Role
org.user.note.writeorg.permission.note.update

Note

This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single note. To learn more, see Rate limiting.

Authorization

The org.admin role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy. Otherwise, these attributes are automatically set by the token.

put/notes/{id}

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/notes/{id}
  • Auth: httpBearer (a scheme the document does not define)

Query parameters

replaceboolean
Example:true

Set to true to update the document. Otherwise, performs the same update as a PATCH request. Default value: false.

Request body

conversationstring required
externalIdstring nullable
bodystring required
deletedboolean nullable
createdAtstring date-time
modifiedAtstring date-time
updatedAtstring date-time
createdBystring object-id
modifiedBystring object-id nullable
langstring nullable

Response

OK

Changes

No recorded changes to this operation across all 8 revisions of this API.