Skip to main content
POST
Schedule follow-ups

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 schedule_followups.

conversation_sid
string
required

The thread the follow-ups continue (ub_cv_…): its last message of ours is what they follow; when the lead wrote last, they count from now.

Required string length: 18
Pattern: ^ub_cv_
followups
object[]
required

The follow-ups in order, 1 to 3; their count is the plan's.

Required array length: 1 - 3 elements
every_days
integer

Days between the follow-ups, 1..30; default the agent settings' person_followups_every_days (3).

Required range: 1 <= x <= 30
voice
enum<string>

sender: written as the sender profile (the person) would write them, continuing their own message; agent: in the AI SDR's own voice. Default: the last message's author.

Available options:
sender,
agent
then
enum<string>

What ends them when none is answered: task opens a task for the person; agent_continues lets the AI SDR follow up on its own. Default the agent settings' person_followups_then.

Available options:
task,
agent_continues

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