Routing Rules

Activate routing rule

Activate a routing rule by ID for a merchant. Only one rule can be active at a time — activating a new rule deactivates the previous one.

post/routing/activate

Request body

created_bystring required
routing_algorithm_idstring required

Example request

{
  "created_by": "test_merchant",
  "routing_algorithm_id": "rule_abc123"
}

Response

Rule activated

rule_idstring nullable
namestring
descriptionstring
created_bystring
algorithm_forstring

Example response

{
  "rule_id": "rule_abc123",
  "created_by": "test_merchant",
  "algorithm": {
    "type": "priority"
  }
}

Changes