Skip to main content
POST
Create a play

Authorizations

Authorization
string
header
required

API key ret_live_… created in Settings → API keys.

Body

application/json

The plays contract (playDraftSchema in app-core). Each field left out takes its default: review before sending, a run every day at 07:00, 10 leads per run, the channel's usual steps.

name
string
required
Maximum string length: 120
signal
string
required

The moment that makes an account worth contacting now.

Maximum string length: 600
segment
string
required

The accounts the play keeps.

Maximum string length: 600
whoToTarget
string
required

The person to reach at each kept account.

Maximum string length: 300
why
string
Maximum string length: 400
context
string[]
Maximum array length: 8
Maximum string length: 120
sequence
object
delivery
object
limits
object

Response

The draft, with defaulted.

id
string
name
string
status
enum<string>
Available options:
draft,
active,
paused,
archived
origin
enum<string>
Available options:
onboarding,
app
launched
boolean
version
integer
created_at
string<date-time>
updated_at
string<date-time>
workspace_id
string | null
schedule_id
string | null

Its scheduled run once launched: GET /v1/scheduled-runs/{id}/runs lists the runs.

config
object

The blocks: signal, segment, whoToTarget, why, context, sequence, delivery. Same shape as PlayDraft.

limits
object
leads
object
left_aside
integer

Qualified people of its table it cannot reach as it is set.

missing_accounts
enum<string>[]

Channels no connected account can send from: nothing leaves on them.

Available options:
email,
linkedin