smsCampaigns

Get an SMS campaign

Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.

get/smsCampaigns/{campaignId}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/smsCampaigns/{campaignId}
  • Auth: API key in header api-key

Path parameters

campaignIdinteger required

id of the SMS campaign

Response

SMS campaign information

contentstring required

Content of the SMS Campaign

createdAtstring required

Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

idinteger required

ID of the SMS Campaign

modifiedAtstring required

UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

namestring required

Name of the SMS Campaign

organisationPrefixstring

A recognizable prefix added as the Brand Name before the message content. Empty string if not set.

scheduledAtstring

UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled.

senderstring required

Sender of the SMS Campaign

sentDatestring

UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is 'sent'.

status'draft' | 'sent' | 'archive' | 'queued' | 'suspended' | 'inProcess' required

Status of the SMS Campaign

unsubscribeInstructionstring

Instructions to unsubscribe from future communications. Empty string if not set.

tagsstring[]

Tags (labels) associated with the SMS campaign. Only available when retrieving a single campaign.

Changes

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