Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung tickets.reply verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Hier kommt Ihre Organisations-ID hin
Dieser Endpunkt akzeptiert org_id als Feld im JSON-Body.
Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/tickets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "subject": <string>, "body": <string> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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`.
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
subject | string | Ja | — |
body | string | Ja | The customer's description — becomes the first message in the thread. |
priority | TicketPriority | Nein | How urgent the ticket is. The customer may propose one; staff decide. |
site_id | string | Nein | The site this is about. Must belong to the same org or the request is a 404. |
invoice_id | string | Nein | The invoice this is about. Must belong to the same org or the request is a 404. |
org_id | string | Nein | The organization to open it in. Required only when the caller holds `tickets.reply` in more than one org. |
on_behalf_of_org_id | string | Nein | 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… |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subject | string | Ja | — |
status | TicketStatus | Ja | Where 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`… |
priority | TicketPriority | Ja | How urgent the ticket is. The customer may propose one; staff decide. |
channel | string | Ja | How the ticket reached us — `dashboard`, `api` or `staff`. Server-decided; an open string so a future channel is additive on both sides. |
site_id | object | Nein | — |
invoice_id | object | Nein | — |
on_behalf_of_org_id | object | Nein | 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_name | object | Ja | The 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_at | object | Nein | — |
resolved_at | object | Nein | — |
closed_at | object | Nein | — |
last_message_at | object | Nein | — |
reopened_count | integer | Ja | — |
message_count | integer | Ja | Customer-visible messages in the thread — internal notes are not counted. |
created_at | string | Ja | — |
updated_at | string | Ja | — |
messages | TicketMessage[] | Ja | The customer-visible thread in chronological order. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422 · 429