support

POST /v1/tickets/{ticketId}/close

Close a support ticket.

All support endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the tickets.reply permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/tickets/{ticketId}/close \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Closes the ticket. Idempotent — closing an already-closed ticket returns it unchanged rather than erroring. Requires tickets.reply.

Parameters

NameTypeRequiredWhat it is
ticketId (path)UuidYesThe ticket's id.

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
subjectstringYes—
statusTicketStatusYesWhere a ticket sits in its lifecycle. open = waiting on us; pending = waiting on the customer; solved = we believe it is resolved and a customer reply reopens it; closed =…
priorityTicketPriorityYesHow urgent the ticket is. The customer may propose one; staff decide.
channelstringYesHow the ticket reached us — dashboard, api or staff. Server-decided; an open string so a future channel is additive on both sides.
site_idobjectNo—
invoice_idobjectNo—
on_behalf_of_org_idobjectNoThe client org a reseller opened this ticket about. Null on every ordinary ticket. ⛔ Validated as a descendant of the ticket's own org and 404d otherwise, so it can never…
assignee_nameobjectYesThe owning agent's display name (first name), or null while unassigned. The customer sees a name so they know a person owns their ticket; the agent's id and email are…
first_response_atobjectNo—
resolved_atobjectNo—
closed_atobjectNo—
last_message_atobjectNo—
reopened_countintegerYes—
message_countintegerYesCustomer-visible messages in the thread — internal notes are not counted.
created_atstringYes—
updated_atstringYes—
messagesTicketMessage[]YesThe customer-visible thread in chronological order.
accessTicketAccessGrant[]YesSite access the customer gave support on this ticket (s1014 L39).

Errors this endpoint can return

401 · 403 · 404 · 429