support

POST /v1/tickets

Open a support ticket.

Gbogbo àwọn support endpoints

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda tickets.reply; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí

Ibi-iwọle yii n gba org_id gẹgẹ bi aaye ninu ara JSON naa.

Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

curl -X POST https://api.zinndigital.com/v1/tickets \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "subject": <string>, "body": <string> }'

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

Opens a ticket in `open` with the supplied `body` as its first message, and publishes `ticket.created` (which sends the customer a localized acknowledgement via the notification consumer). `channel` is server-decided — it is not accepted from the client. A supplied `site_id` or `invoice_id` must belong to the same org or the request is a `404`. Requires `tickets.reply`.

Akoonu ibeere naa

OrúkọIruTí a nílòKini o jẹ
subjectstringBẹẹni
bodystringBẹẹniThe customer's description — becomes the first message in the thread.
priorityTicketPriorityBẹẹkọHow urgent the ticket is. The customer may propose one; staff decide.
site_idstringBẹẹkọThe site this is about. Must belong to the same org or the request is a 404.
invoice_idstringBẹẹkọThe invoice this is about. Must belong to the same org or the request is a 404.
org_idstringBẹẹkọThe organization to open it in. Required only when the caller holds `tickets.reply` in more than one org.
on_behalf_of_org_idstringBẹẹkọThe client org this is about — a reseller escalating to Zinn® on their client's behalf. Must be a **descendant** of the ticket's org or the request is a `404`; your client never…

Idahun

OrúkọIruTí a nílòKini o jẹ
idUuidBẹẹniUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidBẹẹniUUIDv7 identifier — sortable by creation time (docs/02 §8).
subjectstringBẹẹni
statusTicketStatusBẹẹniWhere 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`…
priorityTicketPriorityBẹẹniHow urgent the ticket is. The customer may propose one; staff decide.
channelstringBẹẹniHow the ticket reached us — `dashboard`, `api` or `staff`. Server-decided; an open string so a future channel is additive on both sides.
site_idobjectBẹẹkọ
invoice_idobjectBẹẹkọ
on_behalf_of_org_idobjectBẹẹkọThe **client org** a reseller opened this ticket about. Null on every ordinary ticket. ⛔ Validated as a descendant of the ticket's own org and `404`d otherwise, so it can never…
assignee_nameobjectBẹẹniThe 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 staff-…
first_response_atobjectBẹẹkọ
resolved_atobjectBẹẹkọ
closed_atobjectBẹẹkọ
last_message_atobjectBẹẹkọ
reopened_countintegerBẹẹni
message_countintegerBẹẹniCustomer-visible messages in the thread — internal notes are not counted.
created_atstringBẹẹni
updated_atstringBẹẹni
messagesTicketMessage[]BẹẹniThe customer-visible thread in chronological order.

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 422 · 429