email-connections

Update connection settings (name)

patch/v1/workspaces/{brandId}/email-connections/{connectionId}

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}/email-connections/{connectionId}
  • Auth: bearer (a scheme the document does not define)

Path parameters

connectionIdstring required

Request body

namestring

Display name for the connection

Response

idstring required
brandIdstring required
namestring required

Display name for the connection

isPrimaryboolean required

Whether this is the primary connection for outbound

provider'GMAIL' | 'OUTLOOK' required
emailstring required

Connected email address

status'ACTIVE' | 'ERROR' | 'DISCONNECTED' required
lastSyncAtstring date-time
errorMessagestring
createdAtstring date-time required

Changes

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