Sign in

v1

latestOpenAPI 3.1.02026-07-227350156.5 KB
Category Action Triggers

Incremental category trigger operations at account scope

Perform incremental operations on category action triggers at the account scope.

Supports two operations:

  • add: Register new category triggers or update existing ones. Only the submitted triggers are affected—existing registrations are preserved. If a trigger ID already exists, its registration is replaced (upsert). All registrations are processed synchronously.
  • remove: Remove category triggers by trigger ID. Removed triggers are excluded from enrichment lookups. Trigger IDs that are not currently active are silently ignored (idempotent).

Successful add operations return 201; successful remove operations return 200.

Limit: The total number of active triggers at a scope cannot exceed 300. An add operation that would push the total past this limit will receive a 400 error.

Important: Only one operation can be in progress per scope at a time. Concurrent requests return 409.

To learn more about action triggers, please read the Category Action Triggers Guide.

patch/category-action-triggers

Request body

operation'add' | 'remove' required

The operation to perform:

  • add: Register new category triggers or update existing ones
  • remove: Remove category triggers (excluded from enrichment lookups)
triggerIdsstring[] nullable

List of trigger IDs to remove. Required and must be non-empty for the remove operation.

Trigger IDs that are not currently active are silently ignored (idempotent).

For add operations, this field is optional and ignored if provided — you may pass null, [], or omit it entirely.

Example request

{
  "operation": "add",
  "categoryTriggers": [
    {
      "id": "travel-reward-1",
      "categoryId": "020-001-000-000",
      "action": {
        "type": "REWARD",
        "rewardPercent": 3,
        "offerId": "travel-3x-promo"
      }
    }
  ],
  "triggerIds": [
    "travel-reward-1",
    "block-gambling"
  ]
}

Response

Remove operation completed successfully

status'succeeded'
versioninteger

The version number of this operation.

Example response

{
  "status": "succeeded",
  "version": 5
}