Get a campaign

Get campaign

Get a previously created campaign using its identifier.

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

Authorization

useraccessKey

Path parameters

workspaceId*WorkspaceId (string (uuid))

The ID for the workspace.

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

brandId*string

A unique identifier for the brand.

campaignId*string

A unique identifier for the campaign.

Response

200404

Campaign found

Body

application/json

idstring (uuid)

UUID of the campaign.

namestring

Campaign name

subscriptionCampaignSubscription

Describes status of Campaign Subscription

statusenum

Campaign status

DRAFTFAILEDPENDINGREJECTEDAPPROVEDDECLINEDSUSPENDEDDELETEDEXPIRED

usecasestring

A use case that best matches the purpose of the campaign.

subUsecasesnullable array of string

If use case is MIXED or LOW_VOLUME mixed an array of 2-5 use cases.

descriptionstring

A detailed description of what the campaign is for.

embeddedLinkboolean

Whether messages will contain links. Provide at least one sample containing a link.

embeddedPhoneboolean

Whether messages will contain phone number. Provide at least one sample containing a phone number.

numberPoolboolean

Whether a campaign will be associated with more than 50 numbers e.g. customer service use case.

ageGatedboolean

Whether a campaign contains age-gated content based on carrier/ctia guidelines.

directLendingboolean

Whether a campaign includes content related to direct lending or loan arrangements.

subscriberOptinboolean

Confirm customer opt in is collected and processed.

subscriberOptoutboolean

Confirm customer opt out is collected and processed.

subscriberHelpboolean

Confirm an info message is returned if a customer sends "HELP".

samplesarray of string

Between 1-5 sample messages. If directLending, embeddedPhone, embeddedLink is true provide relevant examples.

messageFlowstring

Provide details of how the customer will opt into this campaign. If you have a live web opt-in provide the URL and ensure the page has details on the T&Cs/data collection for opting in, and how to opt out.

helpMessagestring

Help message of the campaign. A help message shall state the name of the service, contact (email or call centre), OPT IN and OPT OUT keywords.

helpKeywordsstring

A comma separated list of keywords. Support of the word HELP is the minimum requirement for requesting help/info.

optoutKeywordsstring

A comma separated list of keywords. Support of the word STOP is the minimum requirement for OPT OUT.

optinKeywordsstring

A comma separated list of keywords. Support of the word START is the minimum requirement for OPT OUT.

optinMessagestring

Provide an example of the message that will be sent after a customer has opted in.

optoutMessagestring

Provide an example of the message that will be sent after a customer has opted out.

termsAndConditionsboolean

Indicates the campaign follows CTIA messaging principles and best practices.

brandIdstring (uuid)

UUID of the brand associated with this campaign. The specified brand MUST be APPROVED.

rejectionobject

Rejection details

attachmentsarray of Attachment (object)

Attachments associated with this campaign.

createdAtstring (date-time)

Timestamp (UTC) when the campaign was created.

updatedAtstring (date-time)

Timestamp (UTC) when the campaign was last updated.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

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

Type	Description
CampaignReponse	CampaignResponse object describes a submitted campaign