Create Note

Creates a note in a conversation.

The note body must be less than 1000 characters. Attachment-only notes are also accepted.

The note body supports mentioning of users by using the @ symbol followed by the user's ID wrapped in double curly brackets. For example, @{{12}} will mention the user with ID 12. A mentioned user will be notified of the mention via email/SMS/push notifications, depending on their notification settings.

If there is no contact corresponding to the to parameter for the organization, a new contact will be created, along with a conversation with the from number channel. If there is an existing contact but no conversation, a new conversation will be created.

The opt_in_to_all_channels and opt_in_to params are optional and they will be processed in the cases where a new contact is created. These params reflect which of the organization channels the contact will be opted in to.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create Conversation Note Params

attachments
array of strings

List of attachment URLs

attachments
string
length ≤ 1000

Note body

string
required

Phone of an existing channel belonging to your organization

opt_in_to
array of objects

Setting to opt in contact to specific channels

opt_in_to
boolean

Setting to opt in contact to all channels

string
required

Destination phone number

Responses

Callback
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json