Skip to navigation
API ReferenceSms Campaigns

Get SMS campaign info

Get the details for a single SMS campaign.

Authentication

AuthorizationBearer

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

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

sms_campaign_idstringRequired
The unique id for the SMS campaign.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

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.
campaign_segmentsobjectOptionalRead-only

The campaign’s targeting with each segment’s type. regular covers tags and saved segments; advanced covers advanced segments. Segment IDs alone cannot distinguish the two. Returned when you get or update a single campaign. Omitted from list and create responses, for campaigns that send to the whole audience, and for older campaigns saved before segment types were recorded. Read-only: PATCH takes segments and excluded_segments, keeps the type of IDs already on the campaign, and adds new IDs (and IDs on older campaigns) as regular.