Update an integration

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

PATCH/account/integrations

Costs 2 rate-limit points · Rate limits

Update the shop's integrations: sync signups to Klaviyo, Omnisend, Mailchimp or Shopify customers (with the customer tag), the Omnisend and Mailchimp API keys and Mailchimp audience, the Meta Pixel, Shopify Flow triggers and the SplitOrder app switch. API keys are write only; reads return connected flags.

Deep partial: absent fields are unchanged. omnisend.api_key and mailchimp.api_key are never returned by any read; "" or null removes the saved key. A Mailchimp key is checked by fetching the account's audiences and is not saved when Mailchimp refuses it; mailchimp.list_id must be one of those audiences. Klaviyo connects with OAuth from the Integrations page; disconnect with POST /account/integrations/:provider/disconnect. flow_triggers.triggers replaces the stored list. Over MCP or the in-app assistant an API key is refused with code use_key_link and key_url: the merchant enters it in STOQ.

Also searched asconnect omnisendset omnisend api keyconnect mailchimpset mailchimp api keypick mailchimp audiencesync signups to klaviyosync customers to shopifycustomer sync tagturn on meta pixelset meta pixel idenable shopify flow triggersenable splitorderset Postscript keyword

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.

Request body

klaviyostring
Example: string
omnisendstring
Example: string
mailchimpstring
Example: string
shopifystring
Example: string
sync_customers_tagstring
Example: string
meta_pixelstring
Example: string
flow_triggersstring
Example: string
split_order_appstring
Example: string
postscriptstring
Example: string

Errors

401

Missing or invalid X-Auth-Token.

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.

PATCH/account/integrations

curl -X PATCH "https://app.stoqapp.com/api/v2/external/account/integrations" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "klaviyo": "string",
    "omnisend": "string",
    "mailchimp": "string",
    "shopify": "string",
    "sync_customers_tag": "string",
    "meta_pixel": "string",
    "flow_triggers": "string",
    "split_order_app": "string",
    "postscript": "string"
  }'

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/integrations", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "klaviyo": "string",
    "omnisend": "string",
    "mailchimp": "string",
    "shopify": "string",
    "sync_customers_tag": "string",
    "meta_pixel": "string",
    "flow_triggers": "string",
    "split_order_app": "string",
    "postscript": "string"
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.stoqapp.com/api/v2/external/account/integrations",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "klaviyo": "string",
        "omnisend": "string",
        "mailchimp": "string",
        "shopify": "string",
        "sync_customers_tag": "string",
        "meta_pixel": "string",
        "flow_triggers": "string",
        "split_order_app": "string",
        "postscript": "string"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/integrations")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
  klaviyo: "string",
  omnisend: "string",
  mailchimp: "string",
  shopify: "string",
  sync_customers_tag: "string",
  meta_pixel: "string",
  flow_triggers: "string",
  split_order_app: "string",
  postscript: "string"
}.to_json
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": [
    "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
    }
  ]
}