Get a campaign

Type

Description

CampaignResponse object describes a submitted campaign

Last updated 11 months ago

Was this helpful?

Get campaign

Get a previously created campaign using its identifier.

get

/workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId}

Authorizations

Path parameters

workspaceIdstring · uuidrequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

brandIdstringrequired

A unique identifier for the brand.

campaignIdstringrequired

A unique identifier for the campaign.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "subscription": {
    "subscribedAt": "2025-02-21T18:05:46.737Z",
    "updatedAt": "2025-02-21T18:05:46.737Z",
    "cancelledAt": "2025-02-21T18:05:46.737Z",
    "status": "active"
  },
  "usecase": "text",
  "description": "text",
  "embeddedLink": true,
  "embeddedPhone": true,
  "numberPool": true,
  "ageGated": true,
  "directLending": true,
  "subscriberOptin": true,
  "subscriberOptout": true,
  "subscriberHelp": true,
  "messageFlow": "text",
  "helpMessage": "text",
  "helpKeywords": "text",
  "optoutKeywords": "text",
  "optinKeywords": "text",
  "optinMessage": "text",
  "optoutMessage": "text",
  "termsAndConditions": true,
  "brandId": "123e4567-e89b-12d3-a456-426614174000",
  "resellerId": "text",
  "createdAt": "2025-02-21T18:05:46.737Z",
  "updatedAt": "2025-02-21T18:05:46.737Z",
  "status": "DRAFT",
  "subUsecases": [
    "text"
  ],
  "samples": [
    "text"
  ],
  "attachments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "PENDING",
      "createdAt": "2025-02-21T18:05:46.737Z",
      "updatedAt": "2025-02-21T18:05:46.737Z",
      "filename": "attachment.txt",
      "contentType": "text/plain"
    }
  ],
  "rejection": {
    "description": "text",
    "code": "text"
  }
}

Campaign found