Partner API
Patch lead order
PATCH /api/v2/lead-orders/:order_uuid - Partial update of a lead order (supported fields only). Send at least one recognized field.
PATCH
/api/v2/lead-orders/:order_uuidPartial update of a lead order (supported fields only). Send at least one recognized field.
Required scope: lead-orders (or *).
Path parameters
| Name | Required | Description |
|---|---|---|
order_uuid | Yes | Order UUID |
JSON body
| Name | Required | Description |
|---|---|---|
daily_max | No | Daily max override (alias: daily_max_override). Null clears the override. |
states | No | State filter as string (CA,TX) or string array |
curl -s -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"daily_max": 25,
"states": [
"TX",
"FL",
"CA"
]
}' \
"https://benefitpath.com/api/v2/lead-orders/c0a80101-0000-4000-8000-000000000006"{
"success": true,
"order": {
"order_uuid": "c0a80101-0000-4000-8000-000000000006",
"paused": false,
"daily_max_override": 25,
"daily_max": 25,
"states": ["TX", "FL", "CA"]
}
}See Errors for the standard error envelope and rate limits.