Create a campaign

A successful request to this endpoint will mean you are charged a campaign registration fee and a three month minimum commitment fee. If you later need to update or resubmit your brand there may be additional fees.

You must have created a brand that has been approved, before creating a new campaign

Create campaign. A campaign can only be created for an approved brand.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

brandId*string

Body

application/json

name*string

Campaign name

usecase*string

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

subUsecasesarray of string

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

description*string

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".

samples*array of string

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

attachmentUrlsarray of string

Up to 5 attachments.

messageFlow*string

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.

helpMessage*string

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.

termsAndConditions*enum

Indicates the campaign follows CTIA messaging principles and best practices.

true

Response

201422

Campaign successfully created

Body

application/json

idstring (uuid)

UUID of the campaign.

namestring

Campaign name

subscriptionCampaignSubscription

Describes status of Campaign Subscription

statusenum

Campaign status

FAILEDPENDINGREJECTEDAPPROVEDDECLINEDSUSPENDEDDELETEDEXPIRED

usecasestring

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

subUsecasesarray 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

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "usecase": "text",
      "description": "text",
      "samples": [
        "text"
      ],
      "messageFlow": "text",
      "helpMessage": "text",
      "termsAndConditions": true
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "subscription": {
    "status": "active",
    "subscribedAt": "2024-04-29T14:58:04.396Z",
    "updatedAt": "2024-04-29T14:58:04.396Z",
    "cancelledAt": "2024-04-29T14:58:04.396Z"
  },
  "status": "FAILED",
  "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-04-29T14:58:04.396Z",
      "updatedAt": "2024-04-29T14:58:04.396Z",
      "filename": "attachment.txt",
      "contentType": "text/plain"
    }
  ],
  "createdAt": "2024-04-29T14:58:04.396Z",
  "updatedAt": "2024-04-29T14:58:04.396Z"
}

CampaignRequest object

Field	Type	Description	Mandatory
name	string	Name of your use case	Required
useCase	useCase	A use case that best matches the purpose of the campaign	Required
subUsecases	array<useCase>	If use case is MIXED or LOW_VOLUME mixed an array of 2-5 use cases	Optional. Unless useCase is LOW_VOLUME, MIXED
description	string	A detailed description of what the campaign is for	Required
embeddedLink	boolean	Whether messages will contain links. Provide at least one sample containing a link	Required
embeddedPhone	boolean	Whether messages will contain phone number. Provide at least one sample containing a phone number	Required
numberPool	boolean	Whether a campaign will be associated with more than 50 numbers e.g. customer service use case	Required
ageGated	boolean	Whether a campaign contains age-gated content based on carrier/ctia guidelines	Required
directLending	boolean	Whether a campaign includes content related to direct lending or loan arrangements	Required
subscriberOptin	boolean	Confirm customer opt in is collected and processed	Required
subscriberOptout	boolean	Confirm customer opt out is collected and processed	Required
subscriberHelp	boolean	Confirm an info message is returned if a customer sends “HELP”	Required
samples	array<string>	Between 1-5 sample messages. If directLending, embeddedPhone, embeddedLink is true provide relevant examples	Required. At least 1 sample
messageFlow	string	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	Required
helpKeywords	string	A comma separated list of keywords. Support of the word HELP is the minimum requirement for requesting help/info.	Required
optoutKeywords	string	A comma separated list of keywords. Support of the word STOP is the minimum requirement for OPT OUT.	Required
optInKeywords	string	A comma separated list of keywords. Support of the word START is the minimum requirement for OPT OUT.	Optional. Required if subscriberOptin is true
helpMessage	string	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.	Required
optinMesage	string	Provide an example of the message that will be sent after a customer has opted in.	Optional. Required if subscriberOptin is true
optoutMesage	sting	Provide an example of the message that will be sent after a customer has opted out.	Required
termsAndCondtions	boolean	Indicates the campaign follows CTIA messaging principles and best practices	Required

CampaignResponse object

Field	Type	Description
useCase	useCase	A use case that best matches the purpose of the campaign
subUsecases	array<useCase>	If use case is MIXED or LOW_VOLUME mixed an array of 2-5 use cases
description	string	A detailed description of what the campaign is for
embeddedLink	boolean	Whether messages will contain links. Provide at least one sample containing a link
embeddedPhone	boolean	Whether messages will contain phone number. Provide at least one sample containing a phone number
numberPool	boolean	Whether a campaign will be associated with more than 50 numbers e.g. customer service use case
ageGated	boolean	Whether a campaign contains age-gated content based on carrier/ctia guidelines
directLending	boolean	Whether a campaign includes content related to direct lending or loan arrangements
subscriberOptin	boolean	Confirm customer opt in is collected and processed
subscriberOptout	boolean	Confirm customer opt out is collected and processed
subscriberHelp	boolean	Confirm an info message is returned if a customer sends “HELP”
samples	array<string>	Between 1-5 sample messages. If directLending, embeddedPhone, embeddedLink is true provide relevant examples
messageFlow	string	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
helpKeywords	string	A comma separated list of keywords. Support of the word HELP is the minimum requirement for requesting help/info.
optoutKeywords	string	A comma separated list of keywords. Support of the word STOP is the minimum requirement for OPT OUT.
optInKeywords	string	A comma separated list of keywords. Support of the word START is the minimum requirement for OPT OUT.
helpMessage	string	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.
optinMesage	string
optoutMesage	sting	Provide an example of the message that will be sent after a customer has opted in.
termsAndConditions	boolean	Indicates the campaign follows CTIA messaging principles and best practices
brandId	string	Alphanumeric identifier of the brand associated with this campaign. The specified brand MUST be APPROVED.
campaignId	string	Alphanumeric identifier of the campaign
campaignStatus	campaignStatus	Campaign status