Sync Rules

Update sync rules

Changed on

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

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sync-rules
  • Auth
    HTTP bearer

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": []
      }
    }
  ]
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • f1d8cfd9faafRevision changes
    • breaking

      the request property became not nullable