Create a Lead
Creates a lead and returns the created lead.
Authorizations
Token-based authentication with required prefix "Token"
Body
The phone number of the lead. Either E.164 or US format. Must have a valid area code.
1The email address of the lead.
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 standard lead fields 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.
The id of the campaign this lead is a part of.
The id of the representative assigned to this lead.
The external id of the lead. This can be your CRM id.
255The US state of the lead. This is used to determine the timezone of the lead, as well as for compliance with telemarketing regulations.
AL- AlabamaAK- AlaskaAS- American SamoaAZ- ArizonaAR- ArkansasAA- Armed Forces AmericasAE- Armed Forces EuropeAP- Armed Forces PacificCA- CaliforniaCO- ColoradoCT- ConnecticutDE- DelawareDC- District of ColumbiaFL- FloridaGA- GeorgiaGU- GuamHI- HawaiiID- IdahoIL- IllinoisIN- IndianaIA- IowaKS- KansasKY- KentuckyLA- LouisianaME- MaineMD- MarylandMA- MassachusettsMI- MichiganMN- MinnesotaMS- MississippiMO- MissouriMT- MontanaNE- NebraskaNV- NevadaNH- New HampshireNJ- New JerseyNM- New MexicoNY- New YorkNC- North CarolinaND- North DakotaMP- Northern Mariana IslandsOH- OhioOK- OklahomaOR- OregonPA- PennsylvaniaPR- Puerto RicoRI- Rhode IslandSC- South CarolinaSD- South DakotaTN- TennesseeTX- TexasUT- UtahVT- VermontVI- Virgin IslandsVA- VirginiaWA- WashingtonWV- West VirginiaWI- WisconsinWY- Wyoming
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 The source of the lead. This can be used to track the lead provider.
255Response
Lead created successfully.
The phone number of the lead. Either E.164 or US format. Must have a valid area code.
The last time this lead was modified.
The time this lead was created.
The time of the next call scheduled for this lead.
The reasons for the next call scheduled time for this lead.
The time this lead was received by an API call.
The total number of times this lead has been reengaged.
The time this lead was last reengaged.
If True, the lead has been marked as do not contact for the SMS channel (DNC).
If True, the lead has been marked as do not contact for the call channel (DNC).
The email address of the lead.
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 standard lead fields 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.
The status of the lead. This is updated automatically.
UNKNOWN- UnknownNEW- NewOPEN- OpenCALLBACK_TO_TRANSFER- Callback to transferCLOSED- ClosedCLOSED_INCOMPLETE- Closed incompleteLOST- LostSCHEDULE_COMPLETED- Schedule completedOUT_OF_TERRITORY- Out of territoryBAD_NUMBER- Bad numberCANCELLED- Cancelled
UNKNOWN, NEW, OPEN, CALLBACK_TO_TRANSFER, CLOSED, CLOSED_INCOMPLETE, LOST, SCHEDULE_COMPLETED, OUT_OF_TERRITORY, BAD_NUMBER, CANCELLED Sub-type of the status outcome (e.g. blind_transfer, warm_transfer, appointment_booked). This is updated automatically.
blind_transfer- Blind transferwarm_transfer- Warm transferappointment_booked- Appointment bookedlive_handoff_unavailable- Live handoff unavailableescalation- Escalationhas_call_dnc- Has call DNCtcpa_litigator- TCPA litigatorLEAD_ASSIGNED- Lead assigned
blind_transfer, warm_transfer, appointment_booked, live_handoff_unavailable, escalation, has_call_dnc, tcpa_litigator, LEAD_ASSIGNED The reason for the current status of the lead. This is updated automatically.
UNKNOWN- UnknownWEBHOOK- WebhookMANUAL- ManualCHAT- ChatREENGAGEMENT- Reengagement
UNKNOWN, WEBHOOK, MANUAL, CHAT, REENGAGEMENT The id of the campaign this lead is a part of.
The id of the representative assigned to this lead.
The external id of the lead. This can be your CRM id.
255The US state of the lead. This is used to determine the timezone of the lead, as well as for compliance with telemarketing regulations.
AL- AlabamaAK- AlaskaAS- American SamoaAZ- ArizonaAR- ArkansasAA- Armed Forces AmericasAE- Armed Forces EuropeAP- Armed Forces PacificCA- CaliforniaCO- ColoradoCT- ConnecticutDE- DelawareDC- District of ColumbiaFL- FloridaGA- GeorgiaGU- GuamHI- HawaiiID- IdahoIL- IllinoisIN- IndianaIA- IowaKS- KansasKY- KentuckyLA- LouisianaME- MaineMD- MarylandMA- MassachusettsMI- MichiganMN- MinnesotaMS- MississippiMO- MissouriMT- MontanaNE- NebraskaNV- NevadaNH- New HampshireNJ- New JerseyNM- New MexicoNY- New YorkNC- North CarolinaND- North DakotaMP- Northern Mariana IslandsOH- OhioOK- OklahomaOR- OregonPA- PennsylvaniaPR- Puerto RicoRI- Rhode IslandSC- South CarolinaSD- South DakotaTN- TennesseeTX- TexasUT- UtahVT- VermontVI- Virgin IslandsVA- VirginiaWA- WashingtonWV- West VirginiaWI- WisconsinWY- Wyoming
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 The source of the lead. This can be used to track the lead provider.
255