Create Contact

Creates a contact.

Passing a phone number that is already used by an existing contact would get and update the existing contact. It would not try to create a new contact with a duplicate phone number.

Passing an external ID that is already used by an existing contact would get and update the existing contact. If the parameters include a valid phone number and email that differ from those currently associated with the contact, the existing values will be updated accordingly, as long as they don't conflict with other contacts' values.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create Contact Params

Request schema for creating a contact in an organization.

address
object

Optional Address details of the Contact

birth_date
object

Birthday details of the Contact.

uuid

The ID of the channel from which the contact should receive messages by default.

string
length ≤ 255

Contact email

string

The external ID of a contact. It uniquely identifies a contact and can be useful for associating whippy contacts with external systems.

string

The language preference of the Contact

string
length ≤ 255

Contact name

string
required

Contact phone number

properties
object

Contact properties mapped to custom data. These properties are mapped to the custom object in the payload.

The properties keys should correspond to the keys of the custom properties that belong to the custom object.

Responses

Callback
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json