Skip to navigation
API ReferenceSms Campaigns

Add SMS campaign

Create a new SMS campaign.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Request

The settings for creating a new SMS campaign.
namestringRequired
The name of the campaign.
list_idintegerOptional
The numeric ID of the list to send the campaign to.
folder_idstringOptional
The ID of the folder to place this campaign in.
segmentslist of integersOptional
The segment IDs to target for this campaign.
excluded_segmentslist of integersOptional
The segment IDs to exclude from this campaign.

Response

This endpoint returns an object.
idstringOptionalRead-only
A string that uniquely identifies this campaign.
web_idstringOptionalRead-only
The ID used in the Mailchimp web application.
namestringOptional
The name of the campaign.
statusstringOptionalRead-only
The current status of the campaign.
channelstringOptionalRead-only

The channel for this campaign (sms or whatsapp).

list_idintegerOptionalRead-only
The numeric ID of the list associated with this campaign.
recipient_countintegerOptionalRead-only
The number of recipients for this campaign.
create_timedatetimeOptionalRead-only
The date and time the campaign was created.
send_timedatetimeOptionalRead-only
The date and time the campaign is scheduled to send.
updated_atdatetimeOptionalRead-only
The date and time the campaign was last updated.
expire_timedatetimeOptionalRead-only
The date and time the campaign will stop sending in ISO 8601 format.
is_send_nowbooleanOptionalRead-only
Whether the campaign is configured to send immediately.
folder_idstringOptional
The ID of the folder this campaign is in.
segmentslist of integersOptional
The segment IDs used to target recipients for this campaign.
excluded_segmentslist of integersOptional
The segment IDs excluded from receiving this campaign.