Skip to main content
POST
Update Flow Enrollment Candidates Custom Variables

Authorizations

X-API-Key
string
header
required

Body

application/json
flowPlanId
string
required

Flow plan to which all requested candidates must belong.

type
enum<string>
required

One operation for the entire request: upsert or remove.

Available options:
upsert,
remove
items
object[]
required

1 to 100 unique candidates. For upsert supply candidateId and nonempty customVariables; for remove supply candidateId and nonempty keys. Do not mix the two shapes.

Response

Tool result.

updated
string[]
required
failed
object[]
required