brands

Update a brand

patch/v1/workspaces/{brandId}

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

Path parameters

brandIdstring required

Request body

namestring
slugstring

URL-safe identifier

metadataobject
ticketSchemaobject
ticketPrefixstring

Prefix for public ticket IDs (e.g., "AC" -> "AC-1001"). Defaults to brand initials.

ticketNumberStartnumber

Starting number for tickets (default: 1000)

urlstring

Brand website URL

iconUrlstring

Brand icon/favicon URL

fromNamestring

Sender name for outbound emails

fromEmailstring

Sender email for outbound emails (requires Resend domain verification)

autoresponseEnabledboolean

Enable autoresponse emails when new tickets are created

autoresponseSubjectstring

Subject line for autoresponse. Supports {{ticketNumber}}, {{ticketTitle}} placeholders.

autoresponseBodystring

HTML body for autoresponse. Supports {{ticketNumber}}, {{ticketTitle}}, {{customerName}} placeholders.

slaEnabledboolean

Enable SLA for this brand

slaDefaultHoursnumber

Default SLA in hours (e.g., 72 = 3 days)

slaByPriorityobject

SLA hours per priority level

slaNotifyOverdueboolean

Send notifications when tickets are overdue

slaBusinessHoursOnlyboolean

Only count business hours toward SLA deadlines

slaBusinessHoursobject

Business hours config (days: 0=Sun, 6=Sat)

portalOriginsstring[]

Allowed origins for portal API CORS. Empty array = block all cross-origin requests.

chatEnabledboolean

Allow the chat widget to open conversations for this brand

chatAllowedOriginsstring[]

Sites allowed to embed the chat widget. Empty array = none.

Example request

{
  "name": "Acme Corp",
  "slug": "acme-corp",
  "metadata": {
    "industry": "tech"
  },
  "ticketPrefix": "AC",
  "ticketNumberStart": 1000,
  "url": "https://example.com",
  "iconUrl": "https://example.com/favicon.ico",
  "fromName": "Support Team",
  "fromEmail": "support@yourdomain.com",
  "autoresponseEnabled": true,
  "autoresponseSubject": "We received your request [{{ticketNumber}}]",
  "autoresponseBody": "<p>Thank you for contacting us. We have received your request and will respond shortly.</p>",
  "slaEnabled": true,
  "slaDefaultHours": 72,
  "slaByPriority": {
    "urgent": 4,
    "high": 24,
    "normal": 72,
    "low": 168
  },
  "slaNotifyOverdue": true,
  "slaBusinessHours": {
    "start": "09:00",
    "end": "17:00",
    "days": [
      1,
      2,
      3,
      4,
      5
    ],
    "timezone": "America/New_York"
  },
  "portalOrigins": [
    "https://myapp.com",
    "https://www.myapp.com"
  ],
  "chatAllowedOrigins": [
    "https://myapp.com"
  ]
}

Changes

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