Skip to main content
POST
Run a play now

Authorizations

Authorization
string
header
required

API key ret_live_… created in Settings → API keys.

Path Parameters

id
string
required

Id of the play.

Response

The run, queued. It shows in GET /v1/scheduled-runs/{schedule_id}/runs; its leads come in GET /v1/plays/{id}/leads when it ends.

id
string
required
play_id
string
required
schedule_id
string
required

The play's scheduled run: its executions list this run.

scheduled_for
string<date-time>
required
trigger
enum<string>
required
Available options:
schedule,
manual
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
created_at
string<date-time>
required