Skip to main content

Set routing

POST 
/setConnectorRouting/:connectorGuid

Sets the routing rule tree of a routing meta-connector.

The submitted document fully replaces the existing rule tree — there is no partial update. The response echoes the document with all server-assigned rule ids populated. The endpoint is idempotent: resubmitting the same body produces the same final state.

Each node of the tree is either a condition (if, plus then / else branches) or a route leaf (route to a connector with an optional ordered onFail failover chain). Send tree: null to remove all rules.

Use List routing constraints to discover the conditions available to your tenant, and Get routing to fetch the current configuration for round-trip editing.

What the API validates

The document is checked for structural correctness, known conditions with well-formed parameters, tenant-level condition availability, and valid connector references (existing, enabled, non-archived connectors of the same merchant). The API does not assess whether the resulting routing strategy behaves as you intend — see Validation and its limits. Test routing changes against your sandbox environment before applying them to production.

Rate limit

Please be aware of the rate limit for this API endpoint:

  • Total limit: Each unique API user is limited to to 100 requests per 60-second window.

If these limits are exceeded, the server will respond with a HTTP 429 status code, indicating too many requests. Please ensure to manage your requests within these limits to maintain uninterrupted service.

Request​

Responses​

The stored routing configuration, echoing the submitted document with all server-assigned rule ids populated.