Change Management

Create note for change by display ID

POST https://{tenant}.atomicwork.com/api/v1/change-management/changes/{display_id}/notes

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Path Parameters

display_idpathstringrequired

Display ID of the change

Body

user_idbodyinteger

descriptionbodystring

mentionsbodyarray of integer

is_privatebodyboolean

sourcebodyenum (string)

Allowed valuesEMAILSLACKTEAMSPORTALWORKFLOWJOURNEYAPIUNIVERSAL_AGENTRAPID7

typebodyenum (string)

Allowed valuesESD_NOTESLACK_NOTEEMAIL_NOTERATINGTEMPLATEWORKFLOW_NOTE

attachmentsbodyarray of integer

Response

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/change-management/changes/{display_id}/notes' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"user_id": 0, "description": "string", "mentions": [0], "is_private": true, "source": "EMAIL", "type": "ESD_NOTE", "attachments": [0]}'