Skip to main content
POST
/
api
/
leads
/
{id}
/
schedule-outbound
Schedule an Outbound Call
curl --request POST \
  --url https://api.trysela.com/api/leads/{id}/schedule-outbound/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "phone_number": "<string>",
  "lead_type": 123,
  "metadata": "<unknown>",
  "external_id": "<string>",
  "us_state": "AL",
  "lead_source": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

A unique integer value identifying this lead.

Query Parameters

​
next_outbound_datetime
string

Datetime in the future with '%Y-%m-%dT%H:%M:%S%z' format. If not provided, the next available time will be scheduled.

Body

​
email
string<email>
required

The email address of the lead.

​
phone_number
string
required

The phone number of the lead. Either E.164 or US format. Must have a valid area code.

​
lead_type
integer
required

The id of the campaign this lead is a part of.

​
metadata
any | null

Any additional information associated with the lead as json metadata. Any of the values supplied here can be used by the agent in the talk track. Any additional payload fields that are not part of the Lead model will be automatically stored in the metadata upon lead creation or update, so lead metadata can also be sent as additional keys in the payload. Common fields to include in the metadata are first_name and last_name.

​
external_id
string | null

The external id of the lead. This can be your CRM id.

Maximum string length: 255
​
us_state

The US state of the lead. This is used to determine the timezone of the lead, as well as for compliance with telemarketing regulations.

  • AL - Alabama
  • AK - Alaska
  • AS - American Samoa
  • AZ - Arizona
  • AR - Arkansas
  • AA - Armed Forces Americas
  • AE - Armed Forces Europe
  • AP - Armed Forces Pacific
  • CA - California
  • CO - Colorado
  • CT - Connecticut
  • DE - Delaware
  • DC - District of Columbia
  • FL - Florida
  • GA - Georgia
  • GU - Guam
  • HI - Hawaii
  • ID - Idaho
  • IL - Illinois
  • IN - Indiana
  • IA - Iowa
  • KS - Kansas
  • KY - Kentucky
  • LA - Louisiana
  • ME - Maine
  • MD - Maryland
  • MA - Massachusetts
  • MI - Michigan
  • MN - Minnesota
  • MS - Mississippi
  • MO - Missouri
  • MT - Montana
  • NE - Nebraska
  • NV - Nevada
  • NH - New Hampshire
  • NJ - New Jersey
  • NM - New Mexico
  • NY - New York
  • NC - North Carolina
  • ND - North Dakota
  • MP - Northern Mariana Islands
  • OH - Ohio
  • OK - Oklahoma
  • OR - Oregon
  • PA - Pennsylvania
  • PR - Puerto Rico
  • RI - Rhode Island
  • SC - South Carolina
  • SD - South Dakota
  • TN - Tennessee
  • TX - Texas
  • UT - Utah
  • VT - Vermont
  • VI - Virgin Islands
  • VA - Virginia
  • WA - Washington
  • WV - West Virginia
  • WI - Wisconsin
  • WY - Wyoming
Available options:
AL,
AK,
AS,
AZ,
AR,
AA,
AE,
AP,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
GU,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
MP,
OH,
OK,
OR,
PA,
PR,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VI,
VA,
WA,
WV,
WI,
WY
​
lead_source
string | null

The source of the lead. This can be used to track the lead provider.

Maximum string length: 255

Response

Outbound scheduled successfully