API Reference

Update Contact List Contacts

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

Update the contact list contacts in an organization by applying the given action over contacts. Before applying it, the contacts are created or updated in case they already exists, and are opt in to all organization channels by default in case action is add or overwrite. By providing the opt_in_to field you can choose to only opt in the contacts to specific channels. The contact list must be active.

The following actions are supported:

  • add: Adds the contacts to the contact list.

  • remove: Removes the contacts from the contact list.

  • overwrite: Removes all contacts from the contact list and adds the given contacts to it.

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

Contact List ID

Body Params

Update Contact List Contacts Params

string
enum
required

The action to be applied over the contacts param. Can be one of "add", "remove" or "overwrite".

Allowed:
contacts
array of objects
required
length between 1 and 4000

List of contacts that will be processed according to the action.

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.

opt_in_to
array of objects
length between 1 and 1000

Setting to opt in contacts from contacts param to specific channels

opt_in_to
string

Channel ID

string

Channel phone number

boolean
Defaults to true

Setting to opt in contacts from contacts param to all organization channels

Responses

Callback

Updated 6 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 6 months ago