workflows

Create workflow

Create a draft campaign - nothing runs until publish + resume. Optionally seed draft_steps: OMIT step ids (the server assigns them from step_id_seq and returns the array with ids filled). Configure the sender pool (sender_profile_sids + rotation_strategy), the sending window (schedule; null = any time), on_reply and priority. Dedup on (team_sid, name) → already_exists:true. Audiences attach afterwards via workflow-sources, not here.

Contract:

  • MCP tool create_workflow, registry package mcp.playtables/workflows, mount playtables.workflows.
  • Operation create, response envelope create.
  • Flags: none.
post/api/workflows

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

playtable_sidstring required

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

namestring required

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

descriptionstring nullable

Free text about the campaign (max 2000).

on_reply'autopilot' | 'copilot' | 'stop' | 'continue'

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.

sender_profile_sidsstring[]

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

rotation_strategy'fair' | 'random' | 'new_sender' | 'prior_engagement'

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

priorityinteger

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

agent_sidstring nullable

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.

Response

create success envelope.

successtrue required
operation'create' required
already_existsboolean required

Changes

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