Create disconnect

POST

/account/integrations/{provider}/disconnect

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/account/integrations/example/disconnect \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

Disconnect an integration. OAuth (klaviyo, judgeme, gorgias, smile): revokes the connection with the provider and forgets its tokens, as the card’s Disconnect does; a legacy Klaviyo private key is removed instead. API key (postscript, omnisend, mailchimp): removes the key and turns off its sync. Switch (shopify_flow, meta_pixel, split_order, shopify_customers): turns it off.

Note: Connect with POST /account/integrations/:id/connect. Fails with the provider’s error when it refuses; the tokens are kept then. Already disconnected is a 200 with changed false. Removing the Postscript key while it is the SMS provider sends SMS from STOQ, or blocks it when the shop is not verified for restricted content; /account/sending shows which.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

provider

required

string

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

404

The resource does not exist for this shop, or the action path is not registered.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Offer not found"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}