List all Campaigns

Returns a list of the campaigns for a brand. The campaigns are returned sorted by creation date, with the most recent appearing first. The list is filterable by sending in any of the following parameters.

Permissions

The API token must include the following scopes: Messaging.

Path Parameters
id uuid — REQUIRED Unique ID of the brand

Query Parameters
filter_name string The name given to the campaign. Will return all Campaigns containing this value as a substring.
filter_state string The state of the campaign in the registration process, such as pending or complete. Will return all campaigns with this value.

Responses

200 OK Schema — OPTIONAL links object — OPTIONAL self string — OPTIONAL first string — OPTIONAL next string — OPTIONAL prev string — OPTIONAL data object[] — OPTIONAL id uuid The unique id of the campaign. name string — OPTIONAL A name for the campaign. state string — OPTIONAL The current state of the campaign. sms_use_case string — OPTIONAL 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_MIXED, MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL). sub_use_cases string[] — OPTIONAL A sub use case category for MIXED or LOW_VOLUME_MIXED campaigns (CUSTOMER_CARE, HIGHER_EDUCATION, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION, DELIVERY_NOTIFICATION, FRAUD_ALERT). campaign_verify_token string — OPTIONAL 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 — OPTIONAL A description for the campaign. Please use at least 40 characters. sample1 string — OPTIONAL Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters. sample2 string — OPTIONAL Sample 2. sample3 string — OPTIONAL Sample 3. sample4 string — OPTIONAL Sample 4. sample5 string — OPTIONAL Sample 5. dynamic_templates string — OPTIONAL 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. message_flow string — OPTIONAL Please describe the call to action/message flow your intended recipients will experience. opt_in_message string — OPTIONAL Please share the message subscribers receive when they opt in. opt_out_message string — OPTIONAL Please share the message subscribers receive when they opt out. help_message string — OPTIONAL Please share the message subscribers receive when they opt out. opt_in_keywords string — OPTIONAL You can share any opt in keywords that subscribers can use here. Default = START opt_out_keywords string — OPTIONAL You can share any opt in keywords that subscribers can use here. Default = STOP help_keywords string — OPTIONAL You can share any help keywords that subscribers can use here. Default = HELP number_pooling_required boolean — OPTIONAL Will 50 or more numbers be used with this single campaign? If so, please enter true. number_pooling_per_campaign string — OPTIONAL If you will be using number pooling, please provide an explanation as to why it is needed. direct_lending boolean — OPTIONAL Will this campaign include content related to direct lending or other loan agreements? embedded_link boolean — OPTIONAL Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted. embedded_phone boolean — OPTIONAL Are you using an embedded phone number (except the required HELP information contact phone number)? age_gated_content boolean — OPTIONAL Will this campaign include any age gated content as defined by carrier and CTA guidelines? lead_generation boolean — OPTIONAL Is there any intent of this campaign to generate leads? csp_campaign_reference string — OPTIONAL If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit) created_at date-time — OPTIONAL updated_at date-time — OPTIONAL