domains

Update domain settings (sender info, primary status)

patch/v1/brands/{brandId}/domains/{domainId}

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/brands/{brandId}/domains/{domainId}
  • Auth: session-token (a scheme the document does not define)

Path parameters

brandIdstring required
domainIdstring required

Request body

fromEmailstring

The sender email address (must match domain, outbound only)

fromNamestring

The sender display name (outbound only)

isPrimaryboolean

Set this domain as the primary for its type

replyMode'SINGLE' | 'MATCH'

How to determine the reply-from address (SINGLE = use fromEmail, MATCH = match original recipient)

Example request

{
  "fromEmail": "support@acme.com",
  "fromName": "Acme Support",
  "isPrimary": true,
  "replyMode": "SINGLE"
}

Response

Domain updated

Changes

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