Skip to main content
POST
StartPersonCallAPI connects a person to a lead: Erdo rings the person's own

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Body

application/json
canonical_lead_id
string
required

22-character reference form. Required: the lead's timeline finds calls by this id, and a call that could not appear on it would defeat the point.

from_number
string
required

number the lead will see. It must be one Erdo manages inside the organization's Twilio subaccount.

person_phone
string
required

record — the provider already holds it for the duration of the call, and keeping a copy of an employee's mobile beside every lead is not something this feature needs.

placed_by
PersonCallPlacedBy names the human placing the call, in the CALLER's own · object
required

terms. Ref is whatever stable identifier that surface has for them (Maurice sends its Clerk user id); Erdo never resolves it, it only keys the one-live- call-per-person rule on it and shows Name beside the call.

to_number
string
required

it is normalised to E.164 and echoed back.

prompt_language
string

default), "es" or "pt". Anything else is refused rather than silently spoken in English at somebody who does not speak it.

recipient_name
string

call Maria Lopez") and shown on the call record.

Response

Success response

call_id
string

empty when the call was refused.

from_number
string
message
string
person_country
string
person_phone
string
prompt_language
string
reason
string
refused
boolean

PersonCallRefused* values and Message says it in words.

to_country
string
to_number
string

country that number belongs to.