Notes (Conversations)
Conversations (Notes)

Create note within conversation

Creates a new note within a conversation. Optionally, allows you to @mention another user in your Kustomer organization.

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

Legacy RoleEquivalent Permission Set Role
org.user.note.readorg.permission.note.create

Authorization

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

Rate limit

Notes are subject to a rate limit. A single client can create up to 120 notes per minute per customer.

post/conversations/{id}/notes

Request

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

Path parameters

idstring required
Example:<string>

Unique ID of the Conversation

Request body

idstring
conversationstring
externalIdstring
bodystring required
createdAtstring date-time
modifiedAtstring date-time
createdBystring object-id
modifiedBystring object-id
importedAtstring date-time
langstring nullable

Response

Created

Changes