Skip to navigation
Atomicwork Public APIRequests

Create request notes

View as Markdown

Creates a note on the request. The note body may mention individual users (mentions) and agent groups (agent_group_mentions). Public notes notify the requester, assignee and all followers, where the follower set is the union of direct user followers and members of any agent groups following the request, de-duplicated. Agent groups listed in agent_group_mentions are added as request followers. Private/internal notes are excluded from follower notifications.

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

requestIdstringRequired

Headers

X-Workspace-IdstringOptional

Request

Payload to create a request note. Mentions (mentions) and agent-group mentions (agent_group_mentions) can be supplied. Public notes notify the requester, assignee and all followers (direct users plus members of any agent groups following the request, de-duplicated). Agent groups listed in agent_group_mentions are added as request followers.

user_idlongOptional
conversation_idlongOptional

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

descriptionstringOptional
mentionslist of longsOptional
User IDs mentioned in the note. Mentioned users are notified and added as direct followers.
agent_group_mentionslist of longsOptional
Agent group IDs mentioned in the note. Members of these groups are notified and the groups are added as request followers.
is_privatebooleanOptionalDefaults to false
sourceenumOptional
typeenumOptional
attachmentslist of longsOptional
cc_emailslist of stringsOptional
bcc_emailslist of stringsOptional
is_broadcastbooleanOptionalDefaults to false
external_idstringOptional
external_source_typeenumOptional
Allowed values:
email_contentstringOptional
event_created_atdatetimeOptional
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.
transitionobjectOptional

Applied in the same transaction as the note: both commit, or neither does. Takes the same body PATCH /requests/{requestId} accepts

Response

Successful response