Skip to main content
POST
Create sender variable

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

name
string
required

What a person reads ("Calendar link").

Required string length: 1 - 100
slug
string

What a text says after sender.; read off the name when left out. Never changes. first_name, last_name, full_name, name and label are a sender profile's own fields and cannot be taken.

Pattern: ^[a-z][a-z0-9_]{0,63}$
hint
string | null

What it is for ("Books a call. Offer it when someone asks to talk."): the AI SDR and Creator read it.

Maximum string length: 500

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