MAmailchimp
sms-campaigns

Get SMS campaign info

Get the details for a single SMS campaign.

get/3.0/sms-campaigns/{sms_campaign_id}

Request

Path parameters

sms_campaign_idstring required

The unique id for the SMS campaign.

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

Response

idstring

A string that uniquely identifies this campaign.

web_idstring

The ID used in the Mailchimp web application.

namestring

The name of the campaign.

statusstring

The current status of the campaign.

channelstring

The channel for this campaign (sms or whatsapp).

list_idinteger

The numeric ID of the list associated with this campaign.

recipient_countinteger

The number of recipients for this campaign.

create_timestring date-time

The date and time the campaign was created.

send_timestring date-time

The date and time the campaign is scheduled to send.

updated_atstring date-time

The date and time the campaign was last updated.

expire_timestring date-time

The date and time the campaign will stop sending in ISO 8601 format.

is_send_nowboolean

Whether the campaign is configured to send immediately.

folder_idstring

The ID of the folder this campaign is in.

segmentsinteger[]

The segment IDs used to target recipients for this campaign.

excluded_segmentsinteger[]

The segment IDs excluded from receiving this campaign.

Changes

No recorded changes to this operation across all 1 revision of this API.