Requests

Create request notes

POST https://{tenant}.atomicwork.com/api/v1/requests/{requestId}/notes

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Path Parameters

requestIdpathstringrequired

Body

user_idbodyinteger

conversation_idbodyinteger

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

descriptionbodystring

mentionsbodyarray of integer

is_privatebodyboolean

sourcebodyenum (string)

Allowed valuesEMAILSLACKTEAMSPORTALWORKFLOWJOURNEYAPIUNIVERSAL_AGENT

typebodyenum (string)

Allowed valuesESD_NOTESLACK_NOTEEMAIL_NOTERATINGTEMPLATEWORKFLOW_NOTE

attachmentsbodyarray of integer

cc_emailsbodyarray of string

bcc_emailsbodyarray of string

is_broadcastbodyboolean

external_idbodystring

external_source_typebodyenum (string)

Allowed valuesSAAS_GENIESNOWJSM_BRIDGE

email_contentbodystring

event_created_atbodystring

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

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/requests/{requestId}/notes' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"user_id": 0, "conversation_id": 0, "description": "string", "mentions": [0], "is_private": true, "source": "EMAIL", "type": "ESD_NOTE", "attachments": [0], "cc_emails": ["string"], "bcc_emails": ["string"], "is_broadcast": true, "external_id": "string", "external_source_type": "SAAS_GENIE", "email_content": "string", "event_created_at": "date-time"}'