Skip to main content

Campaign Object

The Campaign Object represents a 10DLC (10-Digit Long Code) campaign, which is required for sending messages over standard 10-digit phone numbers in the USA and Canada. This object contains details about the campaign, including its internal and external identifiers, name, and associated partner.

Campaign Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

AttributeData TypeDescription
campaign_sid
read only
stringAn internal secure ID of the 10DLC campaign.
external_id
read only
stringThe 10DLC campaign ID the Campaign Registry has assigned to your campaign upon its registration.
name
read only
stringThe internal name of the 10DLC Campaign.
partner_sid
read only
stringThe secure ID of the partner associated with the campaign

Sample Campaign Object

{
"campaign_sid": "fef13cdd-2f65-4ed8-8272-de2a940d0cb5",
"external_id": "CVN1LXI",
"name": "My 10DLC Campaign",
"partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0"
}