Workflows

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.

post/api/v1/workflows/{id}/executions

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/workflows/{id}/executions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: workflows:write)

Path parameters

idstring uuid required

Workflow id.

Request body

contact_idstring uuid required

Contact to enter the workflow. Must belong to this project.

contextobject

Extra variables merged into the contact's data for this run.

Response

Execution started

completed_atstring date-time nullable required
contact_idstring uuid required
current_step_idstring uuid nullable required
exit_reasonstring nullable required
idstring uuid required
started_atstring date-time required
status'RUNNING' | 'WAITING' | 'COMPLETED' | 'EXITED' | 'FAILED' | 'CANCELLED' required
workflow_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.