Skip to main content
POST
Bulk Set Status

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Close the selected opportunities as LOST or DISQUALIFIED under one shared reason.

opportunityIds
string[]
required

IDs of the opportunities to act on

Minimum array length: 1
status
enum<string>
required

Terminal-capable status for a pursuit episode (separate from stage).

Schema column lands with the opportunity rebuild; enum ships early so intake/services can type against it without a second enum PR.

Available options:
OPEN,
WON,
LOST,
DISQUALIFIED
lostReasonId
string | null

Response

Successful Response

Aggregate result for a bulk action that fans out per opportunity.

succeeded
integer
default:0

Number of opportunities the action succeeded for

skipped
integer
default:0

Number of opportunities that were already in the requested state

failed
OpportunityBulkActionFailure · object[]

Per-opportunity failures with reasons