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

Lead orders

Lead order lifecycle - list, inspect, pause/resume, cancel, and patch. Money-moving ops are rate-limited more strictly.

Operations

MethodPathOperation
GET /api/v2/lead-orders List lead orders
GET /api/v2/lead-orders/:order_uuid Get lead order
PATCH /api/v2/lead-orders/:order_uuid Patch lead order
POST /api/v2/lead-orders/:order_uuid/pause Pause or resume lead order
POST /api/v2/lead-orders/:order_uuid/cancel Cancel lead order