List all Campaigns

GET 
/registry/beta/brands/:id/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.

Request

Path Parameters

id uuidrequired

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

application/json

Schema

Schema

links

object

self string

first string

next string

prev string
data object[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "My Campaign",
      "state": "pending",
      "sms_use_case": "MARKETING",
      "sub_use_cases": [
        "MARKETING",
        "2FA"
      ],
      "campaign_verify_token": null,
      "description": null,
      "sample1": "this is a sample message your customer might receive",
      "sample2": "this is a sample message your customer might receive",
      "sample3": "string",
      "sample4": "string",
      "sample5": "string",
      "dynamic_templates": "string",
      "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,
      "embedded_link": false,
      "embedded_phone": false,
      "age_gated_content": true,
      "lead_generation": true,
      "csp_campaign_reference": "1231231",
      "status_callback_url": "https//example.com/handle_callback",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}

Loading...