Update a campaign
Last updated
Last updated
A successful request to this endpoint will mean you may be charged a .
Field | Type | Description | Mandatory | |
---|---|---|---|---|
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 |
|
Type | Description |
---|---|
CampaignResponse object describes a submitted 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.
The ID for the workspace.
"d386a801-ee8d-4aba-a7e4-78671bd3b11e"
A unique identifier for the brand.
A unique identifier for the campaign.
Campaign name
A use case that best matches the purpose of the campaign. Only editable when campaign is DECLINED.
Whether messages will contain links. Provide at least one sample containing a link. Only editable when campaign is DECLINED.
Whether messages will contain phone number. Provide at least one sample containing a phone number. Only editable when campaign is DECLINED.
Whether a campaign will be associated with more than 50 numbers e.g. customer service use case. Only editable when campaign is DECLINED.
Whether a campaign contains age-gated content based on carrier/CTIA guidelines. Only editable when campaign is DECLINED.
Whether a campaign includes content related to direct lending or loan arrangements. Only editable when campaign is DECLINED.
Between 1-5 sample messages. If directLending, embeddedPhone, embeddedLink is true provide relevant examples.
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.
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.
A comma separated list of keywords. Support of the word HELP is the minimum requirement for requesting help/info.
A comma separated list of keywords. Support of the word STOP is the minimum requirement for OPT OUT.
A comma separated list of keywords. Support of the word START is the minimum requirement for OPT OUT.
Provide an example of the message that will be sent after a customer has opted in.
Provide an example of the message that will be sent after a customer has opted out.
Campaign successfully updated
UUID of the campaign.
Campaign name
Describes status of Campaign Subscription
Campaign status
A use case that best matches the purpose of the campaign.
If use case is MIXED or LOW_VOLUME mixed an array of 2-5 use cases.
A detailed description of what the campaign is for.
Whether messages will contain links. Provide at least one sample containing a link.
Whether messages will contain phone number. Provide at least one sample containing a phone number.
Whether a campaign will be associated with more than 50 numbers e.g. customer service use case.
Whether a campaign contains age-gated content based on carrier/ctia guidelines.
Whether a campaign includes content related to direct lending or loan arrangements.
Confirm customer opt in is collected and processed.
Confirm customer opt out is collected and processed.
Confirm an info message is returned if a customer sends "HELP".
Between 1-5 sample messages. If directLending, embeddedPhone, embeddedLink is true provide relevant examples.
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.
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.
A comma separated list of keywords. Support of the word HELP is the minimum requirement for requesting help/info.
A comma separated list of keywords. Support of the word STOP is the minimum requirement for OPT OUT.
A comma separated list of keywords. Support of the word START is the minimum requirement for OPT OUT.
Provide an example of the message that will be sent after a customer has opted in.
Provide an example of the message that will be sent after a customer has opted out.
Indicates the campaign follows CTIA messaging principles and best practices.
UUID of the brand associated with this campaign. The specified brand MUST be APPROVED.
Rejection details
Attachments associated with this campaign.
Timestamp (UTC) when the campaign was created.
Timestamp (UTC) when the campaign was last updated.