Send Campaign

post https://api.whippy.co/v1/campaigns/sms

Creates and sends an SMS campaign. Attachments for MMS campaigns are also accepted.

Messages will be sent using the channel that corresponds to the from request parameter. The message body must be less than 1000 characters. Attachment-only messages are also accepted.

If there is no contact for the organization corresponding to the parameters in the to list, a new contact will be created, along with a conversation with the from number channel. If there is an existing contact but no conversation, a new conversation will be created.

All contacts will be tagged with an upload tag with a timestamp corresponding to the time of creation of the campaign.

The contacts in the to list will be formatted to have a number in the E.164 format and then validated. If some of them are still invalid, they will be removed from the payload and processing will continue with the valid numbers. If no valid numnbers are left after all invalid ones are excluded, a 422 error will be returned.

When custom_data is provided, the contacts will be associated with a custom object. The custom object and its custom properties must be created before the campaign is created. When specifying custom data, the resource field must be set to contact or campaign_contact in order to associate the custom data with the contact or the campaign contact respectively.

The campaign will be processed in the background, therefore a 202 Accepted status is initally returned on success.

Body Params

Send Campaign Params

attachments

array of strings

List of attachment URLs for the campaign.

attachments

automation_templates

array of uuids

List of IDs of automation templates whose triggers, actions, and keywords will be duplicate for the campaign

automation_templates

body

string

length ≤ 1000

Campaign message body

custom_data

object

Optional field used to indicate that the contacts from the campaign should be associated with a custom object. In combination with the custom_data field, there should be a properties field that contains the actual custom data to be associated with the contacts.

exclude

object

Optional settings to exclude contacts from the campaign

from

string

required

Phone of an existing channel belonging to your organization

schedule_at

date-time

Scheduling time for the campaign. Requires ISO 86001 format.

title

string

required

Campaign title

array of objects

required

length between 1 and 4000

List of contacts that would receive the campaign.

to*

address

object

Optional Address details of the Contact

birth_date

object

Birthday details of the Contact.

default_channel_id

uuid

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

string

length ≤ 255

Contact email

external_id

string

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

language

string

The language preference of the Contact

name

string

length ≤ 255

Contact name

phone

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.

422

Unprocessable Entity

202Campaign

401Not Authenticated

422Unprocessable Entity