v93

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

Update sync rules

Replaces the company's full sync rule set. Send an empty array to disable rules, or null to opt into the inherited SaaS/ecommerce platform preset. This is not a partial update - fetch the current rules, edit them, and send the whole set back.

put/sync-rules

Request body

Example request

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

Response

Sync rules updated

successboolean
messagestring
isDefaultboolean

Example response

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