Update a campaign

A successful request to this endpoint will mean you may be charged a campaign resubmission fee.

Update campaign

A campaign can only be updated when the status is APPROVED or DECLINED. When the campaign is APPROVED only the fields 'description', 'samples', 'messageFlow', 'helpMessage', 'optinKeywords', 'optoutKeywords', 'helpKeywords', 'optinMessage' and 'optoutMessage' can be updated.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

brandId*string

campaignId*string

Body

application/json

namenullable string

Campaign name

descriptionnullable string

A use case that best matches the purpose of the campaign. Only editable when campaign is DECLINED.

embeddedLinknullable boolean

Whether messages will contain links. Provide at least one sample containing a link. Only editable when campaign is DECLINED.

embeddedPhonenullable boolean

Whether messages will contain phone number. Provide at least one sample containing a phone number. Only editable when campaign is DECLINED.

numberPoolnullable boolean

Whether a campaign will be associated with more than 50 numbers e.g. customer service use case. Only editable when campaign is DECLINED.

ageGatednullable boolean

Whether a campaign contains age-gated content based on carrier/CTIA guidelines. Only editable when campaign is DECLINED.

directLendingnullable boolean

Whether a campaign includes content related to direct lending or loan arrangements. Only editable when campaign is DECLINED.

samplesnullable array of string

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

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

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

helpKeywordsnullable string

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

optoutKeywordsnullable string

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

optinKeywordsnullable string

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

optinMessagenullable string

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

optoutMessagenullable string

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

Response

200400422

Campaign successfully updated

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/{campaignId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

CampaignUpdate object

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

CampaignResponse object

Type	Description
CampaignReponse	CampaignResponse object describes a submitted campaign