Skip to navigation
Atomicwork Public APIChange Management

Create note for change by display ID

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

display_idstringRequired
Display ID of the change

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
transitionobjectOptional

Applied in the same transaction as the note: both commit, or neither does. Takes the same body PATCH /api/change-management/changes/{displayId} accepts

Response

Successful response