Update integrations
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/integrationsCosts 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-KeystringA 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 (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
klaviyoobjectKlaviyo settings; sync_customers turns syncing signups to the connected Klaviyo account on or off.
Show 1 child attributeHide child attributes
sync_customersbooleanSync visitors who sign up to the connected Klaviyo account.
omnisendobjectOmnisend settings, the API key and whether signups are synced to Omnisend.
Show 2 child attributesHide child attributes
api_keystringOmnisend API key. Write only: reads return omnisend.connected. "" removes the key.
sync_customersbooleanSync visitors who sign up to Omnisend. Needs an Omnisend API key.
mailchimpobjectMailchimp settings, the API key, the audience signups go to and whether they are synced.
Show 3 child attributesHide child attributes
api_keystringMailchimp API key (ends in the data centre, e.g. "-us21"). Write only: reads return mailchimp.connected. Checked by fetching the account's audiences; a key Mailchimp refuses is not saved. "" removes the key.
list_idstringId of the Mailchimp audience signups go to. Must be an audience of the connected account.
One ofsync_customersbooleanSync visitors who sign up to Mailchimp. Needs a key and an audience.
shopifyobjectShopify customer sync settings.
Show 1 child attributeHide child attributes
sync_customersbooleanCreate or update a Shopify customer for each signup, with the tag below.
sync_customers_tagstringTag put on synced customer profiles.
meta_pixelobjectMeta Pixel settings, whether conversion events are sent and the pixel they go to.
Show 2 child attributesHide child attributes
enabledbooleanSend conversion events to the merchant's Meta Pixel.
pixel_idstringThe Meta Pixel id events go to.
flow_triggersobjectShopify Flow settings, whether STOQ fires Flow triggers and which ones.
Show 2 child attributesHide child attributes
enabledbooleanFire Shopify Flow triggers for STOQ events.
triggersarray of stringsWhich Shopify Flow triggers fire. REPLACES the stored list.
split_order_appobjectSplitOrder app settings.
Show 1 child attributeHide child attributes
enabledbooleanHand preorders to the SplitOrder app.
postscriptobjectPostscript opt-in keyword settings.
Show 2 child attributesHide child attributes
keywordstringThe Postscript keyword subscribers text to opt in. One of GET /account/integrations/postscript/keywords.
keyword_idstringId of that Postscript keyword.
Returns
klaviyoobjectShow 8 child attributesHide child attributes
sync_customersbooleanExample:trueoauth_token_expires_atnullExample:2026-11-14T09:30:00ZconnectedbooleanExample:trueconnection_methodnullExample:oauthoauth_token_validbooleanExample:trueoauth_needs_refreshbooleanExample:falseemail_setup_verifiedbooleanExample:truesms_setup_verifiedbooleanExample:false
omnisendobjectShow 2 child attributesHide child attributes
sync_customersbooleanExample:falseconnectedbooleanExample:false
mailchimpobjectShow 3 child attributesHide child attributes
list_idstring, nullablesync_customersbooleanExample:falseconnectedbooleanExample:false
shopifyobjectShow 1 child attributeHide child attributes
sync_customersbooleanExample:true
sync_customers_tagstringExample:restock-rocketmeta_pixelobjectShow 2 child attributesHide child attributes
enabledbooleanExample:truepixel_idstring, nullableExample:1234567890123456
flow_triggersobjectShow 2 child attributesHide child attributes
enabledbooleanExample:truetriggersarray of strings
split_order_appobjectShow 1 child attributeHide child attributes
enabledbooleanExample:false
postscriptobjectShow 4 child attributesHide child attributes
keywordstring, nullablekeyword_idstring, nullableconnectedbooleanExample:falsesms_setup_verifiedbooleanExample:false
judgemeobjectShow 1 child attributeHide child attributes
connectedbooleanExample:true
gorgiasobjectShow 1 child attributeHide child attributes
connectedbooleanExample:false
smileobjectShow 1 child attributeHide child attributes
connectedbooleanExample:false
Errors
not_foundThe path is valid but nothing with that id exists in this store.
conflictThe request is well formed, but the resource's current state does not allow it.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
use_key_linkThrough an assistant or MCP, a third-party API key would pass through a model, so STOQ refuses it and returns the dashboard link where the merchant enters it.
validation_failedThe action refused the request for a reason that is not a single bad field.
shopify_errorA Shopify call the operation needs failed after the operation had started.
upstream_unavailableA service the answer depends on did not respond in time.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
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 '{
"meta_pixel": {
"enabled": true,
"pixel_id": "1234567890123456"
},
"flow_triggers": {
"enabled": true,
"triggers": [
"flow-customer-signed-up",
"flow-customer-placed-preorder"
]
}
}'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({
"meta_pixel": {
"enabled": true,
"pixel_id": "1234567890123456"
},
"flow_triggers": {
"enabled": true,
"triggers": [
"flow-customer-signed-up",
"flow-customer-placed-preorder"
]
}
}),
});
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={
"meta_pixel": {
"enabled": True,
"pixel_id": "1234567890123456"
},
"flow_triggers": {
"enabled": True,
"triggers": [
"flow-customer-signed-up",
"flow-customer-placed-preorder"
]
}
},
)
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 = {
meta_pixel: {
enabled: true,
pixel_id: "1234567890123456"
},
flow_triggers: {
enabled: true,
triggers: [
"flow-customer-signed-up",
"flow-customer-placed-preorder"
]
}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"klaviyo": {
"sync_customers": true,
"oauth_token_expires_at": "2026-11-14T09:30:00Z",
"connected": true,
"connection_method": "oauth",
"oauth_token_valid": true,
"oauth_needs_refresh": false,
"email_setup_verified": true,
"sms_setup_verified": false
},
"omnisend": {
"sync_customers": false,
"connected": false
},
"mailchimp": {
"list_id": null,
"sync_customers": false,
"connected": false
},
"shopify": {
"sync_customers": true
},
"sync_customers_tag": "restock-rocket",
"meta_pixel": {
"enabled": true,
"pixel_id": "1234567890123456"
},
"flow_triggers": {
"enabled": true,
"triggers": [
"flow-customer-signed-up",
"flow-customer-placed-preorder"
]
},
"split_order_app": {
"enabled": false
},
"postscript": {
"keyword": null,
"keyword_id": null,
"connected": false,
"sms_setup_verified": false
},
"judgeme": {
"connected": true
},
"gorgias": {
"connected": false
},
"smile": {
"connected": false
}
}{
"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
}
]
}