Create note
Use this method to create a new note. Use notes to notify your team on important matters regarding a conversation with a customer. More info
Please log in to see full path URL. Learn why.
post
/ccaas/1/conversations/{conversationId}/notes
Authorizations:
Scopes:
path Parameters
| conversationId required | string Id of the conversation to set note to. |
Request Body schema:
application/jsoncollapse all -
| content required | string [ 0 .. 4000 ] characters Notes content can be any text. |
| agentId | string [ 0 .. 255 ] characters Agent Id, creator of note. |
| type | string Enum: "INTERNAL" "AUTH_BIOMETRY_INIT" "AUTH_BIOMETRY_PENDING" "AUTH_BIOMETRY_SUCCESS" "AUTH_BIOMETRY_EXPIRED" "AUTH_BIOMETRY_CANCEL" "AUTH_BIOMETRY_FAILED" "AUTH_AGENT_SUCCESS" "AUTH_AGENT_EXPIRED" "AUTH_BOT_SUCCESS" "AUTH_BOT_EXPIRED" "JIRA_COMMENT" "ATTACHMENT" "INTERNAL" "ATTACHMENT" |
Responses
200
OK
400
Bad request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Example
Text note.
Text note.
Copy
Collapse all {- "content": "Note content",
- "agentId": "c856e230-a8cd-498b-9996-42bbed35029a"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Example
Successful response for a text note
Successful response for a text note
Copy
Collapse all {- "id": "1367466e-7e5d-40d7-a78a-ace2780ed3dd",
- "conversationId": "4461ea29-c09e-4ba8-a751-df86cf0a0eb9",
- "agentId": "c856e230-a8cd-498b-9996-42bbed35029a",
- "type": "INTERNAL",
- "content": "Note content",
- "createdAt": "2024-01-01T00:00:00.000+00:00",
- "updatedAt": "2024-01-01T00:00:00.000+00:00"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
