v93

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB

Sync Rules

Get sync rules

Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with an empty rule set; legacy companies may inherit the optional SaaS/ecommerce platform preset. isDefault reports whether that preset is active.

get/sync-rules

Response

Sync rules returned

successboolean

isDefaultboolean

True while the company still uses the platform default rules.

Example response

{
  "success": true,
  "syncRules": [
    {
      "triggerEvent": "ecommerce.order_placed",
      "actions": {
        "addTags": [
          "vinyl-collector"
        ],
        "removeTags": []
      }
    }
  ]
}