Sync Rules

Get sync rules

Changed on

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

Request

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

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

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

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status