Sign in

v1

latestOpenAPI 3.1.02026-08-04147764567.0 KB
requests

Create request notes

post/api/v1/requests/{requestId}/notes

Path parameters

requestIdstring required

Headers

X-Api-Keystring required
X-Workspace-Idstring

Request body

user_idinteger
conversation_idinteger

When set, the reply is mirrored into this conversation's thread (UAG).

descriptionstring
mentionsinteger[]
is_privateboolean
source'EMAIL' | 'SLACK' | 'TEAMS' | 'PORTAL' | 'WORKFLOW' | 'JOURNEY' | 'API' | 'UNIVERSAL_AGENT'
type'ESD_NOTE' | 'SLACK_NOTE' | 'EMAIL_NOTE' | 'RATING' | 'TEMPLATE' | 'WORKFLOW_NOTE'
attachmentsinteger[]
cc_emailsstring[]
bcc_emailsstring[]
is_broadcastboolean
external_idstring
external_source_type'SAAS_GENIE' | 'SNOW' | 'JSM_BRIDGE'
email_contentstring
event_created_atstring date-time

Event creation timestamp. When provided via public API, also backdates the note's created time, SLA metrics, and activity timestamps. Must not be in the future or before the request's creation time.

Response

Successful response

RequestsPostapiV1RequestsRequestIdNotesResponse200 required

Empty response body