API Reference

Opt In

post
https://api.whippy.co/v1/contacts/communication_preferences/opt_in

Opts in a list of contacts to a list of channels.

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

Opt In Communication Preference Params

Communication preferences opt in params.

channels
array of objects
required
length between 1 and 1000

List of channels that contacts be opted in to.

channels*

Data for a channel to opt contacts in to.

string

Channel ID

string

Channel phone number

contacts
array of objects
required
length between 1 and 1000

List of contacts that would be opted in.

contacts*

Data for a contact that would be opted in.

Provide phone when opting in to SMS or WhatsApp channels, and email
when opting in to email channels. When opting in to multiple channels,
provide phone, email, or both.

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

boolean

Whether the contact is opted in to email at the organization level

boolean

Whether the contact is opted in to SMS at the organization level

boolean

Whether the contact is opted out of all organization-level channel types

string

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

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?