Disconnect an integration

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

POST/account/integrations/{provider}/disconnect

Costs 2 rate-limit points · Rate limits

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.

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.

Also searched asdisconnect klaviyodisconnect judge.medisconnect gorgiasdisconnect smileremove postscript keydisconnect omnisenddisconnect mailchimpturn off shopify flow

Path parameters

providerstringRequired

Headers

Idempotency-Keystring
A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Errors

401

Missing or invalid X-Auth-Token.

404

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

409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422

The request failed validation.

429

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

Every error has the same shape: see Errors.

POST/account/integrations/{provider}/disconnect

curl -X POST "https://app.stoqapp.com/api/v2/external/account/integrations/{provider}/disconnect" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/integrations/{provider}/disconnect", {
  method: "POST",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.post(
    "https://app.stoqapp.com/api/v2/external/account/integrations/{provider}/disconnect",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/integrations/{provider}/disconnect")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

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

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}