Skip to main content
POST
Credentials are verified against Gorgias live before storage. Replacing an existing connection requires confirm_replace.

Request body

ConnectGorgias
string
required
The Gorgias account domain, e.g. ‘acme’ or ‘acme.gorgias.com’.
string (email)
required
The Gorgias agent email the API key belongs to.
string
required
An API key from Settings → You → REST API.
boolean
Required (true) when the organization already has a Gorgias connection — connecting replaces it.

Response

Returns object.

Status codes

Access