API Reference

Create Contact List

post
https://api.whippy.co/v1/contacts/lists

Creates a contact list in the current organization.

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

Create Contact List Params

string

Hex color code for the contact list tag

contacts
array of objects
length between 1 and 4000

List of contacts that would comprise the contact list

contacts
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.

string

Contact list name. It is important to notice that any extra spaces are removed from it, e.g. " List   name  " -> "List name".

opt_in_to
array of objects
length between 1 and 1000

Setting to opt in contact to specific channels

opt_in_to
string

Channel ID

string

Channel phone number

boolean

Setting to opt in contact from the contact list to all organization channels

Responses

Callback

Updated 7 months ago

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

Updated 7 months ago