Developers
Tickets9

Create a ticket reply

POST/support/tickets/{ticket_id}/replies

Adds a reply to the ticket conversation on behalf of the support team. The reply is attributed to the credential that made the request (author.kind is credential).

Authorization

AuthorizationBearer <token>

Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

ticket_id*string

Public ID of the ticket, prefixed with tkt_.

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/support/tickets/string/replies" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "attachments": [      {        "file_id": "string",        "name": "string",        "url": "string"      }    ],    "author": {      "id": "string",      "kind": "user"    },    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "object": "ticket_reply",    "revision": "string",    "text": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

List ticket replies GET

Returns the ticket conversation in chronological order, oldest message first, using cursor-based pagination. The collection includes messages from the user and from the support team. Messages are ordered by created_at and then id. There is no newest-first, reverse, or last-page query: obtaining the latest messages requires traversing to the end. Use page.next_cursor unchanged to continue; null or empty means the end. A small limit bounds each page, not the total conversation.

Retrieve a ticket reply GET

Retrieves a single message from the ticket conversation. The message must belong to the ticket in the path; otherwise the API returns `404 Not Found`. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the reply to avoid overwriting a newer version.