Developers
Tickets9

Create a ticket

POST/support/tickets

Opens a support ticket on behalf of the specified user. The ticket is owned by that user, but its first message is attributed to the credential that made the request, not to the user.

If user_id, department_id, or product_id does not reference a resource accessible with the current credentials, the request is rejected with a validation error for that field.

Authorization

AuthorizationBearer <token>

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

In: header

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

curl -X POST "https://example.com/support/tickets" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "message": {      "text": "string"    },    "subject": "string",    "user_id": "string"  }'
{  "data": {    "anonymous": {      "document": "string",      "email": "string",      "name": "string",      "whatsapp": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "department_id": "string",    "id": "string",    "last_reply_at": "2019-08-24T14:15:22Z",    "object": "ticket",    "product_id": "string",    "replies_count": 0,    "revision": "string",    "status": "open",    "subject": "string",    "updated_at": "2019-08-24T14:15:22Z",    "user": {      "email": "user@example.com",      "id": "string",      "name": "string"    }  }}

List tickets GET

Returns the support tickets in the account, using cursor-based pagination. The collection can be filtered by user, product, support department, status, a text search, and last update time, and sorted by `updated_at`. If the credentials are restricted to specific users or products, only tickets within that scope are returned.

Retrieve a ticket GET

Retrieves a support ticket by its public ID. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the ticket to avoid overwriting a newer version. If the credentials are restricted to specific users or products, tickets outside that scope return `404 Not Found`, the same response as a ticket that does not exist.