Deploy
Contacts
Contacts live in CallShift's CRM, one per phone number. Campaigns create them, calls find them, and their data reaches the agent's prompt.
Fields
| Field | Values |
|---|---|
phoneNumber | E.164. The key a contact is matched by. |
salutation | mr, mrs, ms, miss |
firstName, lastName | Text |
email | A valid address, or leave it out |
information | Free text the agent reads |
metadata | Any JSON object. Replaces the whole stored object when sent, and takes precedence over information. |
optedOut | Never dial this contact |
Create or update
- POST
/v1/campaigns/{campaignId}/contactscreates or updates contacts by phone number, and queues a call for each. - PATCH
/v1/contact/{contactId}changes one contact without calling it. The contact id comes with every call in the after-call webhook (contact.id). - POST
/v1/contact-opted-outmarks a number as opted out.
