Start workflow runs

post

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

Enrols candidates in a published workflow, one run per candidate. Runs start after the call returns, so the response reports what Popp accepted rather than the runs. Follow the runs with List workflow runs or the WORKFLOW_CONTACT_RESOLVED and WORKFLOW_RUN_STARTED webhooks.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workflowId

string

required

The workflow ID.

Body Params

Send at least one candidate across candidateProfileIds, candidateProfileExternalIds and contacts, and no more than 5,000 in total.

candidateProfileIds

array of strings

Popp candidate profile IDs to enrol into the workflow.

candidateProfileIds

candidateProfileExternalIds

array of strings

Your external IDs for existing candidate profiles in your organization. One in the wrong format is reported in errors[].

candidateProfileExternalIds

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

Your metadata for this batch of runs, as a JSON-encoded string. It appears in each run's context when applicable.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Popp accepted the request. summary accounts for every entry. An entry that can't be enrolled doesn't fail the request.

400The body failed validation, or the workflow is not published.

401The x-api-key or x-organization-id header is missing.

403The workflow belongs to another organization.

404No workflow has this ID.

422The body is not valid JSON.

500Something failed on our side.