Skip to main content
PUT
/
api
/
v1
/
sync-rules
Update Sync Rules
curl --request PUT \
  --url https://api.sequenzy.com/api/v1/sync-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "syncRules": {}
}
'
{
  "success": true,
  "message": "Saved 1 sync rule.",
  "syncRules": [
    {
      "triggerEvent": "ecommerce.order_placed",
      "actions": { "addTags": ["vinyl-collector"], "removeTags": [] },
      "conditions": {
        "purchasedProduct": { "tags": ["Vinyl"] }
      }
    }
  ],
  "isDefault": false
}
Replaces the full sync rule set, or resets to the platform defaults when null is sent. This is not a partial update - fetch the current rules with Get Sync Rules, edit them, and send the whole set back.

​
Request

​
syncRules
array | null
required
Full replacement rule set, or null to reset to the platform defaults. Each rule has triggerEvent, actions.addTags, actions.removeTags, and optional conditions (requiresTags, requiresNotTags, and purchasedProduct with tags, collectionIds, productTypes, or vendors for commerce events that carry products).
Tag buyers of a product tag: 
curl -X PUT "https://api.sequenzy.com/api/v1/sync-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "syncRules": [
      {
        "triggerEvent": "ecommerce.order_placed",
        "actions": { "addTags": ["vinyl-collector"], "removeTags": [] },
        "conditions": {
          "purchasedProduct": { "tags": ["Vinyl"] }
        }
      }
    ]
  }'
Reset to the platform defaults: 
curl -X PUT "https://api.sequenzy.com/api/v1/sync-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"syncRules": null}'

​
Responses

{
  "success": true,
  "message": "Saved 1 sync rule.",
  "syncRules": [
    {
      "triggerEvent": "ecommerce.order_placed",
      "actions": { "addTags": ["vinyl-collector"], "removeTags": [] },
      "conditions": {
        "purchasedProduct": { "tags": ["Vinyl"] }
      }
    }
  ],
  "isDefault": false
}