Start workflow runs

post

https://api.joinpopp.com/v1/workflows/{workflowId}/runs

Enrols one or more candidates into a published workflow. Provide candidates by ID, by external ID, or as inline contacts (combined cap of 5000). Enrolment is asynchronous — every accepted entry is enqueued and its run is created downstream, so runs are not returned inline. Inspect summary for the rollup and errors[], alreadyEnrolled[], duplicatesInRequest[] for per-entry dispositions; per-entry failures never fail the whole call.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workflowId

uuid

required

Identifier of the workflow.

Body Params

Candidates to enrol into the workflow.

Input for starting one or more workflow runs. Provide candidates by ID, by external ID, or as inline contacts. At least one entry is required across the three lists; the combined total must not exceed 5000. Inline contacts are resolved to or created as candidate profiles before runs start.

candidateProfileIds

array of strings

List of Popp candidate profile IDs to enrol into the workflow.

Candidate Profile IDs

candidateProfileExternalIds

array of strings

List of caller-supplied external IDs identifying candidate profiles. Each must already be associated with a candidate profile in your organization.

Candidate Profile External IDs

contacts

array of objects

Inline contact details. Each contact is resolved to or created as a candidate profile, then enrolled into the workflow. Use this when you do not yet have a Popp candidate profile for the contact.

Contacts

triggerMetadata

string

Optional JSON-encoded string containing caller-supplied metadata associated with this batch of runs. Surfaced on the resulting WorkflowRun.context when applicable.

Responses

202

400

401

403

404

500