tickets

Create a new ticket in a brand

post/v1/workspaces/{workspaceId}/tickets

Request

  • Base URL: https://api.dispatchtickets.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dispatchtickets.com/v1/workspaces/{workspaceId}/tickets
  • Auth: HTTP bearer

Headers

x-idempotency-keystring required
X-Idempotency-Keystring

Unique key to prevent duplicate ticket creation (UUID recommended)

Request body

titlestring required
bodystring
status'open' | 'pending' | 'resolved' | 'closed'
priority'low' | 'normal' | 'medium' | 'high' | 'urgent'
assigneeIdstring
createdBystring
customFieldsobject

Flexible custom fields - any JSON structure (max 64KB)

metadataobject
source'api' | 'web' | 'email' | 'slack' | 'sms' | 'discord' | 'instagram' | 'twitter' | 'whatsapp' | 'recurring' | 'chat' | 'custom'

Source channel where the ticket originated

sourceIdstring

Original ID from the source (email message-id, slack thread ts, etc.)

sourceDataobject

Additional source-specific data (max 64KB)

categoryIdstring

Category ID (must exist in brand)

tagsstring[]

Tag names (will be created if they don't exist)

dueAtstring

Due date (ISO 8601). Auto-set from brand SLA if not provided.

notifyCustomerboolean

Send a confirmation email to the customer when ticket is created (manual tickets only)

attachmentIdsstring[]

IDs of pending attachments to associate with the ticket

Example request

{
  "title": "Cannot login to dashboard",
  "body": "Getting a 500 error when I try to login...",
  "status": "open",
  "priority": "high",
  "assigneeId": "user_agent_123",
  "createdBy": "user_customer_456",
  "links": [
    {
      "url": "https://github.com/acme/app/issues/123",
      "title": "Related GitHub issue",
      "type": "github_issue"
    }
  ],
  "customFields": {
    "browser": "Chrome 120",
    "errorCode": 500,
    "tags": [
      "urgent",
      "billing"
    ]
  },
  "metadata": {
    "source": "web"
  },
  "source": "email",
  "sourceId": "<message-id@mail.example.com>",
  "sourceData": {
    "from": "customer@example.com",
    "subject": "Help needed"
  },
  "categoryId": "cat_abc123",
  "tags": [
    "urgent",
    "billing"
  ],
  "dueAt": "2025-04-01T00:00:00Z",
  "notifyCustomer": true,
  "watchers": [
    {
      "memberId": "mem_abc123",
      "memberEmail": "user@example.com",
      "memberName": "John Doe"
    }
  ],
  "attachmentIds": [
    "att_abc123",
    "att_def456"
  ]
}

Response

Ticket already created (idempotent retry)

Changes

No recorded changes to this operation across all 1 revision of this API.