Create a native contact
Adds one person to this sub-account.
phone is the only required field, because a contact that cannot be dialled is not a contact to this product. It is normalised to E.164: a ten-digit number is read as North American, and anything else must carry + or 00. A number that cannot be made into one is refused rather than guessed at, so a typo never rings a stranger.
The number is unique within the sub-account; a second create for the same number is refused. To change a contact you already have, PATCH it.
customFields takes the keys from List custom fields, and a value is checked against its field’s type. A key that does not exist is an error rather than a silent drop.
A new contact starts any campaign whose trigger is “New contact”.
The do-not-call history outlives the contact. If this number asked not to be called before, and the contact was deleted since, the new row comes back carrying that decision, with the date, reason and door it was made through, and suppressedFromHistory: true beside it. It will not be dialled. That is deliberate: a paid-for lead that nothing will ever call must not be handed back as a bare success.
Cookie-auth callers must send the x-csrf-token header.
Required API key scope: contacts:write.
Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Query Parameters
The sub-account. It is the only thing that identifies the tenant on these routes, and it is re-checked against your access on every call. A sub-account that keeps its contacts in a CRM answers 400.
Body
The person.
Required. E.164, or a ten-digit North American number. Anything else must carry + or 00.
"+13125550142"
100"Ana"
100"Diaz"
254"ana@example.com"
An IANA zone such as America/Chicago. An unknown one is refused rather than producing an agent that offers 3am.
"America/Chicago"
200200200200Keyed by field key. A key with no definition is an error.
Create the contact already suppressed.
500Response
The contact as stored. suppressedFromHistory appears when this number was already on do-not-call.
