Update a campaign

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

Update campaign

patch

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.

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.

Body

namestring | nullableOptional

Campaign name

descriptionstring | nullableOptional

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

embeddedLinkboolean | nullableOptional

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

embeddedPhoneboolean | nullableOptional

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

numberPoolboolean | nullableOptional

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

ageGatedboolean | nullableOptional

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

directLendingboolean | nullableOptional

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

samplesstring[] | nullableOptional

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

messageFlowstring | nullableOptional

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 | nullableOptional

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 | nullableOptional

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

optoutKeywordsstring | nullableOptional

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

optinKeywordsstring | nullableOptional

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

optinMessagestring | nullableOptional

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

optoutMessagestring | nullableOptional

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

resellerIdstring · uuid | nullableOptional

UUID of the reseller associated with this campaign. The specified reseller MUST be ACTIVE.

Responses

200

Campaign successfully updated

application/json

400

Unable to update campaign

application/json

422

Invalid campaign

application/json

patch

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/tcr-brands/{brandId}/campaigns/{campaignId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "name": "text",
  "description": "text",
  "embeddedLink": true,
  "embeddedPhone": true,
  "numberPool": true,
  "ageGated": true,
  "directLending": true,
  "samples": [
    "text"
  ],
  "messageFlow": "text",
  "helpMessage": "text",
  "helpKeywords": "text",
  "optoutKeywords": "text",
  "optinKeywords": "text",
  "optinMessage": "text",
  "optoutMessage": "text",
  "resellerId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "subscription": {
    "status": "active",
    "subscribedAt": "2025-05-09T05:37:51.411Z",
    "updatedAt": "2025-05-09T05:37:51.411Z",
    "cancelledAt": "2025-05-09T05:37:51.411Z"
  },
  "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-05-09T05:37:51.411Z",
      "updatedAt": "2025-05-09T05:37:51.411Z",
      "filename": "attachment.txt",
      "mediaUrl": "https://example.com/attachment.txt",
      "contentType": "text/plain"
    }
  ],
  "createdAt": "2025-05-09T05:37:51.411Z",
  "updatedAt": "2025-05-09T05:37:51.411Z"
}

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