DRAFT status will not be returned. Click here for more information about campaigns.
URL Params
The number of campaigns to return (default 10).
The number of campaigns to skip (i.e. offset).
Response
An array of campaign objects returned.
Show campaign fields
Show campaign fields
The ID of the retrieved campaign.
The display name of the campaign.
The time the campaign was created.
The time the campaign was last updated.
Monthly renewal fee for the campaign (cents).
The usecase for the campaign, i.e.
MARKETING.An array of sub-usecases (optional).
Object of submission details for the campaign.
Show details fields
Show details fields
A description of the messaging campaign.
An explanation of how consent is obtained.
A screenshot of the consent flow (optional).
A sample message for the campaign.
A sample message for the campaign.
A sample message for the campaign (optional).
A sample message for the campaign (optional).
A sample message for the campaign (optional).
Array of keywords that trigger opt-in.
Array of keywords that trigger opt-out.
Array of keywords that trigger HELP message.
Message sent in response to opt-in keyword.
Message sent in response to opt-out keyword.
Message sent in response to HELP keyword.
Error message if the request fails.
Copy
{
"campaigns": [
{
"id": "h4cQ2gls",
"brandId": "A8wm4k2s",
"displayName": "Internal Testing",
"createdAt": "2023-12-12T12:33:33.630Z",
"updatedAt": "2023-12-12T12:33:33.630Z",
"status": "ACTIVE",
...
},
{
"id": "A8wm4k2s",
"brandId": "oR439zks",
"displayName": "User Notifications",
"createdAt": "2023-12-07T12:33:33.630Z",
"updatedAt": "2023-12-08T12:33:33.630Z",
"status": "PENDING",
...
}
And so on...
]
}