comments

Add a comment to a ticket (deprecated: use /brands/:brandId)

post/v1/workspaces/{workspaceId}/tickets/{ticketId}/comments

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/{ticketId}/comments
  • Auth: HTTP bearer

Path parameters

workspaceIdstring required
ticketIdstring required

Headers

x-idempotency-keystring required
X-Idempotency-Keystring

Unique key to prevent duplicate comment creation (UUID recommended)

Request body

bodystring required
authorIdstring
authorNamestring
authorType'CUSTOMER' | 'AGENT' | 'SYSTEM'
parentIdstring

Parent comment ID for threaded replies

metadataobject

Additional metadata (max 64KB)

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

Source channel where the comment originated

sourceIdstring

Original ID from the source

sourceDataobject

Additional source-specific data (max 64KB)

setStatus'open' | 'pending' | 'resolved'

Optionally set the ticket status when adding this comment

connectionIdstring

Email connection ID to send the reply from (uses primary if not specified)

ccstring[]

CC recipients for the email reply

Example request

{
  "body": "Thanks for reporting. Can you share more details?",
  "authorId": "user_agent_123",
  "authorName": "John Smith",
  "links": [
    {
      "url": "https://github.com/acme/app/issues/123",
      "title": "Related GitHub issue",
      "type": "github_issue"
    }
  ],
  "source": "email",
  "sourceId": "<reply-id@mail.example.com>",
  "sourceData": {
    "from": "customer@example.com"
  },
  "setStatus": "pending",
  "connectionId": "emc_abc123",
  "cc": [
    "manager@example.com",
    "team@example.com"
  ]
}

Response

Comment already created (idempotent retry)

Changes

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