Skip to main content
POST
Create workflow

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_workflow.

playtable_sid
string
required

The home playtable (pt_tb_…): the people the workflow enrolls and the record columns its steps read.

Required string length: 18
Pattern: ^pt_tb_
name
string
required

Campaign name; dedup natural key within the team - duplicate returns the existing row with already_exists:true.

Required string length: 1 - 255
description
string | null

Free text about the campaign (max 2000).

Maximum string length: 2000
draft_steps
object[]

Initial step document (chain-and-blocks; see the step schema). Default []. Omit step ids - server assigns and returns them.

schedule
object | null

The campaign's sending windows (per-dow minute blocks + timezone). Default null = any time; gtm-api's per-account limits still pace.

on_reply
enum<string>

Default copilot. What a reply does: autopilot | copilot pause the records and hand the thread to the AI SDR (it answers, or drafts for approval); stop pauses and leaves the thread to a human; continue keeps sending.

Available options:
autopilot,
copilot,
stop,
continue
sender_profile_sids
string[]

Sender pool (ub_sp_…, existence-checked). Default []. Publish requires >=1 when the graph has send steps.

Required string length: 18
Pattern: ^ub_sp_
rotation_strategy
enum<string>

Default 'fair'. Sender pinned per record at enrollment.

Available options:
fair,
random,
new_sender,
prior_engagement
priority
integer

Cross-workflow task scheduling weight per sender, 1..3; default 2.

Required range: 1 <= x <= 3
agent_sid
string | null

The AI SDR for the threads this workflow starts (ub_ag_…, from search_agents on unibox); left out or null = its home table's pick, else the team's default.

Required string length: 18
Pattern: ^ub_ag_

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required