Skip to main content

Retrieve a Campaign

Retrieves the details of a Campaign that has been previously created. Use the unique ID that was returned from your previous request to identify the specific Campaign.

Path Parameters
id uuid REQUIRED

Unique ID of the campaign

Responses
200

OK

Schema
id uuid

The unique id of the campaign.

name string

A name for the campaign.

state string

The current state of the campaign.

sms_use_case string

An SMS Use Case category for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CONVERSATIONAL, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, LOW_VOLUME, MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL).

campaign_verify_token string

Campaign Verifiy token. Required if sms use case is POLITICAL_SECTION_527. (Some U.S. wireless carriers require political committees to obtain Campaign Verify verification in order to access special political campaign classes for the new 10DLC text messaging routes. Visit www.campaignverify.org for more information and to obtain your token)

description string

A description for the campaign.

sample1 string

Sample message template/content. At least one sample is required and up to five can be provided.

sample2 string

Sample 2.

sample3 string

Sample 3.

sample4 string

Sample 4.

sample5 string

Sample 5.

dynamic_templates string

If your messaging content will be modified in any way beyond what you shared in your templates, please describe the nature of how the content will change.

opt_in_description string

Please provide a description of how users provide their number to you and how they consent to receiving SMS messages.

opt_out_description string

Opt-out process description, or a URL to view the opt out process.

number_pooling_per_campaign string

Will 50 or more numbers be used with this single campaign? If answering yes, please provide an explanation as to why it is needed.

direct_lending boolean

Will this campaign include content related to direct lending or other loan agreements?

embedded_link boolean

Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted.

embedded_phone boolean

Are you using an embedded phone number (except the required HELP information contact phone number)?

affiliate_marketing boolean

Is affiliate marketing being used, or was it used in the construction of this campaign?

age_gated_content boolean

Will this campaign include any age gated content as defined by carrier and CTA guidelines?

lead_generation boolean

Is there any intent of this campaign to generate leads?

csp_campaign_reference string

If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit)

created_at date-time
updated_at date-time