Skip to main content
POST
/
routing
/
rules
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "conditions": [
      {}
    ],
    "targetFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "priority": 123,
    "isActive": true,
    "firmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Public API key (format cxp_<tier>_<body>, tier = ro|std|full). Scoped to a single firm. The firm must have public_api in allowedIntegrations.

Body

application/json
​
name
string
required
​
conditions
object[]
required
​
targetFirmId
string<uuid>
required
​
priority
integer
Required range: x >= 0
​
isActive
boolean
default:true

Response

Created routing rule

​
data
object
required
​
meta
object
required