Get a campaign
Get a previously created campaign using its identifier.
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
The ID for the workspace.
d386a801-ee8d-4aba-a7e4-78671bd3b11e
brandIdstringRequired
A unique identifier for the brand.
campaignIdstringRequired
A unique identifier for the campaign.
Responses
200
Campaign found
application/json
404
Campaign or brand not found
application/json
get
GET /workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"subscription": {
"status": "active",
"subscribedAt": "2025-07-03T02:14:05.138Z",
"updatedAt": "2025-07-03T02:14:05.138Z",
"cancelledAt": "2025-07-03T02:14:05.138Z"
},
"status": "DRAFT",
"usecase": "text",
"subUsecases": [
"text"
],
"description": "text",
"embeddedLink": true,
"embeddedPhone": true,
"numberPool": true,
"ageGated": true,
"directLending": true,
"subscriberOptin": true,
"subscriberOptout": true,
"subscriberHelp": true,
"samples": [
"text"
],
"messageFlow": "text",
"helpMessage": "text",
"helpKeywords": "text",
"optoutKeywords": "text",
"optinKeywords": "text",
"optinMessage": "text",
"optoutMessage": "text",
"termsAndConditions": true,
"brandId": "123e4567-e89b-12d3-a456-426614174000",
"resellerId": "text",
"rejection": {
"description": "text",
"code": "text"
},
"attachments": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"status": "PENDING",
"createdAt": "2025-07-03T02:14:05.138Z",
"updatedAt": "2025-07-03T02:14:05.138Z",
"filename": "attachment.txt",
"mediaUrl": "https://example.com/attachment.txt",
"contentType": "text/plain"
}
],
"createdAt": "2025-07-03T02:14:05.138Z",
"updatedAt": "2025-07-03T02:14:05.138Z"
}
Type
Description
CampaignResponse object describes a submitted campaign
Last updated
Was this helpful?