REST ClientRegistryBrands

list_campaigns

View as MarkdownOpen in Claude

List messaging campaigns under a brand.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the brand.

Query parameters

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

Response

datalist of objectsOptional
List of campaigns.

Response Example

Response
1{
2 "links": {
3 "self": "string",
4 "first": "string",
5 "next": "string",
6 "prev": "string"
7 },
8 "data": [
9 {
10 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11 "name": "My Campaign",
12 "state": "pending",
13 "sms_use_case": "MARKETING",
14 "sub_use_cases": [
15 "string"
16 ],
17 "campaign_verify_token": "string",
18 "description": "string",
19 "sample1": "this is a sample message your customer might receive",
20 "sample2": "this is a sample message your customer might receive",
21 "sample3": "string",
22 "sample4": "string",
23 "sample5": "string",
24 "dynamic_templates": "string",
25 "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.",
26 "opt_in_message": "Thanks for subscribing. Reply STOP to cancel at any time.",
27 "opt_out_message": "You have successfully been opted out. Reply START to opt back in at any time.",
28 "help_message": "You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.",
29 "opt_in_keywords": "Start,Subscribe,Opt In",
30 "opt_out_keywords": "Stop,Opt Out,Unsubscribe",
31 "help_keywords": "Help,Support,Request Call",
32 "number_pooling_required": true,
33 "number_pooling_per_campaign": "We have customer reps in every state and they each need their own number with local area code.",
34 "direct_lending": true,
35 "embedded_link": false,
36 "embedded_phone": false,
37 "age_gated_content": true,
38 "lead_generation": true,
39 "csp_campaign_reference": "1231231",
40 "status_callback_url": "https://example.com/handle_callback",
41 "created_at": "2024-01-15T09:30:00Z",
42 "updated_at": "2024-01-15T09:30:00Z"
43 }
44 ]
45}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4 project="your-project-id",
5 token="your-api-token",
6 host="your-space.signalwire.com",
7)
8
9campaigns = client.registry.brands.list_campaigns("brand-id")
10for c in campaigns.get("data", []):
11 print(c.get("description"), c.get("usecase"))