Support API
Open, read, reply to, close, and reopen support tickets.
Support tickets are scoped to your account. The list returns only the tickets you opened, and you can read or act on a ticket only if it is yours. These operations are generated from the curated OpenAPI spec.
When you open a ticket you provide a subject and a first message, and you can tag it with a category (billing, technical, account, abuse, general, or feature request) and a priority (low, normal, high, or urgent). Our team replies in the same thread, and you can close or reopen a ticket at any time.
Support updates are in-app only. Replies and status changes show up in the portal on the ticket thread, so check there for activity. We do not email you about ticket updates. (Email notifications are reserved for alert policies, and only to a verified address.)
Authorization
bearerAuth Bearer JWT obtained after Google sign-in in the portal.
In: header
Response Body
application/json
curl -X GET "https://example.com/v1/support/tickets"[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subject": "string",
"status": "open",
"created_at": "2019-08-24T14:15:22Z",
"messages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"author": "customer",
"body": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}
]Authorization
bearerAuth Bearer JWT obtained after Google sign-in in the portal.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/support/tickets" \ -H "Content-Type: application/json" \ -d '{ "subject": "string", "body": "string" }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subject": "string",
"status": "open",
"created_at": "2019-08-24T14:15:22Z",
"messages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"author": "customer",
"body": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}Authorization
bearerAuth Bearer JWT obtained after Google sign-in in the portal.
In: header
Path Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subject": "string",
"status": "open",
"created_at": "2019-08-24T14:15:22Z",
"messages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"author": "customer",
"body": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}{
"error": "validation failed",
"request_id": "01J9Z3K8QWERTYUIOP"
}Authorization
bearerAuth Bearer JWT obtained after Google sign-in in the portal.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages" \ -H "Content-Type: application/json" \ -d '{ "body": "string" }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"author": "customer",
"body": "string",
"created_at": "2019-08-24T14:15:22Z"
}Authorization
bearerAuth Bearer JWT obtained after Google sign-in in the portal.
In: header
Path Parameters
Response Body
application/json
curl -X POST "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08/close"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subject": "string",
"status": "open",
"created_at": "2019-08-24T14:15:22Z",
"messages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"author": "customer",
"body": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}Authorization
bearerAuth Bearer JWT obtained after Google sign-in in the portal.
In: header
Path Parameters
Response Body
application/json
curl -X POST "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08/reopen"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subject": "string",
"status": "open",
"created_at": "2019-08-24T14:15:22Z",
"messages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"author": "customer",
"body": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}