Campaign Registry: Campaigns
List campaigns
Returns a list of campaigns for a brand.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging and Numbers.
Learn more about API scopes.
get/api/relay/rest/registry/beta/brands/{id}/campaigns
Path parameters
idstring uuid required
Universal Unique Identifier.
Unique ID of the brand.
Query parameters
filter_namestring
The name given to the campaign. Will return all Campaigns containing this value as a substring.
filter_statestring
The state of the campaign in the registration process, such as pending or complete. Will return all campaigns with this value.
Response
The request has succeeded.
Example response
{
"data": [
{
"name": "My Campaign",
"state": "pending",
"sms_use_case": "MARKETING",
"sample1": "this is a sample message your customer might receive",
"sample2": "this is a sample message your customer might receive",
"message_flow": "Users will opt in to receive messages from their doctor through a written form and we will send them an opt in message. Appointment reminders will then be sent ahead of their appointments.",
"opt_in_message": "Thanks for subscribing. Reply STOP to cancel at any time.",
"opt_out_message": "You have successfully been opted out. Reply START to opt back in at any time.",
"help_message": "You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.",
"opt_in_keywords": "Start,Subscribe,Opt In",
"opt_out_keywords": "Stop,Opt Out,Unsubscribe",
"help_keywords": "Help,Support,Request Call",
"number_pooling_required": true,
"number_pooling_per_campaign": "We have customer reps in every state and they each need their own number with local area code.",
"direct_lending": true,
"age_gated_content": true,
"lead_generation": true,
"csp_campaign_reference": "1231231",
"status_callback_url": "https://example.com/handle_callback"
}
]
}