Connect Gorgias with an agent email + REST API key

Credentials are verified against Gorgias live before storage. Replacing an existing connection requires confirm_replace.

POST /api/v1/integrations/gorgias

cURL

curl --request POST \
  --url 'https://response.stateset.com/api/v1/integrations/gorgias' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "domain": "string",
  "email": "[e-mail]",
  "api_key": "YOUR_API_KEY",
  "confirm_replace": true
}'

200

{
  "object": "integration.connection",
  "provider": "gorgias",
  "connected": true,
  "domain": "string",
  "next_action": "string"
}

Credentials are verified against Gorgias live before storage. Replacing an existing connection requires confirm_replace.

Request body

ConnectGorgias

domain · string · required

The Gorgias account domain, e.g. ‘acme’ or ‘acme.gorgias.com’.

email · string (email) · required

The Gorgias agent email the API key belongs to.

api_key · string · required

An API key from Settings → You → REST API.

confirm_replace · boolean

Required (true) when the organization already has a Gorgias connection — connecting replaces it.

Response

object

object · string · required

provider · string · required

connected · boolean · required

domain · string · required

The normalised Gorgias account handle (without .gorgias.com).

next_action · string · required

Status codes

Code	Meaning
200	The verified connection. The credentials were validated with a live call to the account before being stored.
400	Invalid request. issues names the offending field(s).
401	Missing, invalid, or expired API key.
403	The key lacks a required scope.
409	Conflict — either the creation ceiling was reached for this organization (agent_limit_reached), or a request with the same Idempotency-Key is still in flight (idempotency_in_progress); retry the latter after the first attempt settles.
429	Rate limit exceeded.

Access

Required scope	agents:write
Rate limit	30 requests per minute

cURL

curl --request POST \
  --url 'https://response.stateset.com/api/v1/integrations/gorgias' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "domain": "string",
  "email": "[e-mail]",
  "api_key": "YOUR_API_KEY",
  "confirm_replace": true
}'

200

{
  "object": "integration.connection",
  "provider": "gorgias",
  "connected": true,
  "domain": "string",
  "next_action": "string"
}