Bulk import tickets from an external source

Import up to 100 tickets per request from an external system (HappyFox, Zendesk, CSV, etc.).

Idempotency: Tickets are deduplicated by source + sourceId. Safe to retry failed batches.

Auto-creation: Statuses, categories, tags, customers, and field definitions are automatically created if they don't exist. Statuses are matched by key first, then by name (case-insensitive), then auto-created.

Side effects skipped: Webhooks, email notifications, usage counting, entitlement checks, and CSAT surveys are all skipped since the data is historical.

Attachments: Created as PENDING records and downloaded in the background via a job queue. Source URLs should be publicly accessible (presigned URLs are fine — no Authorization header is sent).

Error isolation: Each ticket is processed independently. One failure does not affect the rest of the batch.

post/v1/workspaces/{workspaceId}/import

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}/import
Auth: HTTP bearer

Request body

sourcestring required

Import source identifier

Example request

{
  "source": "happyfox",
  "tickets": [
    {
      "sourceId": "HF-1234",
      "title": "Help with billing",
      "body": "Full description...",
      "status": "in_progress",
      "priority": "high",
      "customer": {
        "email": "user@example.com",
        "name": "John Doe"
      },
      "assigneeEmail": "agent@company.com",
      "category": "Billing",
      "tags": [
        "urgent",
        "vip"
      ],
      "customFields": {
        "order_id": "ORD-123"
      },
      "createdAt": "2024-01-15T10:00:00Z",
      "comments": [
        {
          "sourceId": "HF-C-5678",
          "body": "Agent reply text...",
          "authorType": "AGENT",
          "authorEmail": "agent@company.com",
          "authorName": "Jane Agent",
          "createdAt": "2024-01-16T10:00:00Z",
          "attachments": [
            {
              "url": "https://cdn.example.com/file.pdf",
              "filename": "receipt.pdf",
              "contentType": "application/pdf"
            }
          ]
        }
      ],
      "attachments": [
        {
          "url": "https://cdn.example.com/file.pdf",
          "filename": "receipt.pdf",
          "contentType": "application/pdf"
        }
      ]
    }
  ]
}

Response

Import completed. Returns summary counts, per-ticket results, and any errors.

Changes

No recorded changes to this operation across all 2 revisions of this API.