Create request notes | Atomicwork

curl -X POST https://{tenant}.atomicwork.com/api/v1/requests/requestId/notes \
     -H "X-Workspace-Id: {{workspace_id}}" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "user_id": 123456,
  "description": "Follow-up note regarding the recent service request update.",
  "mentions": [
    78910,
    112233
  ],
  "is_private": true,
  "source": "EMAIL",
  "type": "ESD_NOTE",
  "attachments": [
    445566
  ],
  "cc_emails": [
    "teamlead@example.com",
    "supportmanager@example.com"
  ],
  "bcc_emails": [
    "audit@example.com"
  ],
  "is_broadcast": false,
  "external_id": "ext-req-20240615-001",
  "external_source_type": "SAAS_GENIE",
  "email_content": "Dear team, please review the attached logs and update the ticket accordingly.",
  "event_created_at": "2024-06-15T09:30:00Z"
}'

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

requestIdstringRequired

Headers

X-Workspace-IdstringOptional

Request

This endpoint expects an object.

user_idlongOptional

descriptionstringOptional

mentionslist of longsOptional

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.

Response

Successful response