Skip to navigation

createRequestNote

View as Markdown

Add a note to a request.

Adds a note (comment/reply) to an existing request ticket. Notes are the primary communication mechanism within a ticket — use them to post investigation findings, troubleshooting steps, resolution summaries, or any other updates.

Parameters

NameTypeRequiredDescription
requestIdstringYesThe request display ID (e.g., REQ-123, INC-456)
user_idintegerNo
conversation_idintegerNoWhen set, the reply is mirrored into this conversation’s thread (UAG).
descriptionstringNo
mentionsinteger[]NoUser IDs mentioned in the note. Mentioned users are notified and added as direct followers.
agent_group_mentionsinteger[]NoAgent group IDs mentioned in the note. Members of these groups are notified
is_privatebooleanNoDefault: False.
sourceobjectNo
typeobjectNo
attachmentsinteger[]No
cc_emailsstring[]No
bcc_emailsstring[]No
is_broadcastbooleanNoDefault: False.
external_idstringNo
external_source_typeobjectNo
email_contentstringNo
event_created_atstring (date-time)NoEvent creation timestamp. When provided via public API, also backdates the note’s created time, SLA metrics, and activit
transitionobjectNoApplied in the same transaction as the note: both commit, or neither does. Takes the same body PATCH /requests/{requestI