Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Cancel lead order

POST /api/v2/lead-orders/:order_uuid/cancel - Cancels a lead order. Returns 404 if missing or already cancelled.

POST/api/v2/lead-orders/:order_uuid/cancel

Cancels a lead order. Returns 404 if missing or already cancelled.

Required scope: lead-orders (or *).

Path parameters

NameRequiredDescription
order_uuidYesOrder UUID
 
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/lead-orders/c0a80101-0000-4000-8000-000000000006/cancel"
{ "success": true, "cancelled": true }

See Errors for the standard error envelope and rate limits.