Start a workflow for a contact
Enters one contact into an enabled workflow. Step processing runs asynchronously, so a 201 means the run was claimed — not that it finished.
409 when the workflow's re-entry policy already accounts for this contact; 429 when the workflow's own max_executions_per_hour cap is reached.
Requires the workflows:write scope — Create, edit, enable, and delete your automation workflows.
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
id*stringWorkflow id.
uuidapplication/json- body
Body for POST /api/v1/workflows/{id}/executions.
contact_id*stringContact to enter the workflow. Must belong to this project.
uuidcontext?Extra variables merged into the contact's data for this run.
Execution started
application/json- response
One contact's run through a workflow.
id*stringuuidworkflow_id*stringuuidcontact_id*stringuuidstatus*string"RUNNING""WAITING""COMPLETED""EXITED""FAILED""CANCELLED"current_step_id*|uuidexit_reason*string|nullstarted_at*stringdate-timecompleted_at*|date-timecurl -X POST 'https://api.sendly.now/api/v1/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/executions' \ -H 'Content-Type: application/json' \ -d '{ "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "status": "RUNNING", "current_step_id": "7ea464a2-c5aa-44f1-a236-bca8c839d1c0", "exit_reason": "string", "started_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z"}