Create a new service ticket note.
Create a service ticket note
This endpoint adds a note to an existing service ticket, or is used to migrate note history from another system into Bloxs.
Each note must be submitted in a separate request.
As an alternative for bulk history, a PDF containing the note history can be generated and uploaded as a single file through the Add file to a service ticket endpoint.
The ticket is identified by its internal reference, its external identifier, or both.
Unlike Get a service ticket and Add file to a service ticket, reference and externalIdentifier are passed in the request body here, not as query parameters.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | Internal identifier of the service ticket to add the note to. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values. |
externalIdentifier | string | Conditional | External identifier of the service ticket to add the note to, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values. |
message | string | Yes | Content of the note, for example to explain why it was added or to provide additional context. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | No | Internal identifier of the service ticket the note was added to. |
externalIdentifier | string | No | External identifier of the service ticket the note was added to. |
message | string | Yes | Content of the note that was added. |
The service ticket note was created
The service ticket note data has validation issues
There was a problem creating the note for the service ticket