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

Pause or resume lead order

POST /api/v2/lead-orders/:order_uuid/pause - Pauses (default) or resumes a lead order. Body pause=false resumes.

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

Pauses (default) or resumes a lead order. Body pause=false resumes.

Required scope: lead-orders (or *).

Path parameters

NameRequiredDescription
order_uuidYesOrder UUID

JSON body

NameRequiredDescription
pauseNotrue (default) to pause, false to resume
 
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "pause": true
}' \
  "https://benefitpath.com/api/v2/lead-orders/c0a80101-0000-4000-8000-000000000006/pause"
{ "success": true, "paused": true }

See Errors for the standard error envelope and rate limits.