> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a service ticket note
> Create a new service ticket note.
## OpenAPI
````json POST /api/v1/maintenance/servicetickets/notes
{
"openapi": "3.0.4",
"info": {
"title": "Maintenance V1",
"description": "# Maintenance API Documentation\nWelcome to BETA version of the new Maintenance API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.\n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## Operations \n\nThe API supports operations for the following: \n\n- **Service Tickets**\n\nFor each type, you can: \n\n- **GET**: Retrieve a list or apply filters.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Metadata"
},
{
"name": "ServiceTickets"
}
],
"paths": {
"/api/v1/maintenance/servicetickets/notes": {
"post": {
"tags": [
"ServiceTickets"
],
"summary": "Create a service ticket note",
"description": "Create a new service ticket note.",
"operationId": "CreateServiceTicketNote",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceTicketNote"
}
}
}
},
"responses": {
"200": {
"description": "The service ticket note was created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceTicketNote"
}
}
}
},
"400": {
"description": "The service ticket note data has validation issues",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
},
"404": {
"description": "There was a problem creating the note for the service ticket",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
}
},
"x-d360-narrative-url": "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. |