To create a new campaign, CSPs use the endpoints listed under the Campaign Builder section of the CSP OpenAPI specification. Each campaign must be created with a specific use case, and some require brands to have specific optional attributes, such as a confirmed Tax Exempt Status or Government Entity property.
The full list of supported parameters for a campaign can be found in the POST /campaignBuilder endpoint.
Information on this page pertains to the creation of 10DLC campaigns. While TCR supports RCS campaign creation and management in its CSP portal, this functionality is not yet available in the API.
Newly created campaigns are assigned a unique campaignId which will appear in the response. Also, any MNO metadata pertaining to the submitted campaign will be returned. If the submitted campaign request meets the requirements for at least one MNO, then the campaign is created in TCR and the registration fee is charged to the CSP account.
Before You Begin
-
Check the kinds of campaigns your brand can support with the
GET /campaignBuilder/brand/{brandId}endpoint.
You can also determine whether a brand supports a specific use case with the GET /campaignBuilder/brand/{brandId}/usecase/{usecase} endpoint.
Request
POST /campaignBuilder
curl -X 'POST' \
'https://csp-api-staging.campaignregistry.com/v2/campaignBuilder' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"brandId": "B123ABC",
"usecase": "MARKETING",
"subUsecases": [],
"resellerId": "R000000",
"description": "Promotions, motivational messages, events, news, and membership information for a community gym.",
"embeddedLink": true,
"embeddedPhone": true,
"termsAndConditions": true,
"numberPool": false,
"ageGated": false,
"directLending": false,
"subscriberOptin": true,
"subscriberOptout": true,
"subscriberHelp": true,
"sample1": "Community Health Club: Thank you for registering with us at Community Health Club. We can'\''t wait to meet you and get you started on your journey! Someone will give you a call soon to answer any questions you may have and get you scheduled to start your trial! Reply STOP to opt-out or HELP for help.",
"sample2": "Community Health Club: Hey {first_name}, You’ve hit double digits with 10 classes at Community Health Club! Keep up the great work! Reply STOP to opt-out.",
"sample3": "Hi {first_name}, thank you for being a part of Community Health Club! We would love to hear about your experience with us. Please reply with your rating, with '\''1'\'' being a poor experience and '\''5'\'' being an exceptional experience. Reply STOP to opt-out.",
"sample4": null,
"sample5": null,
"messageFlow": "Members opt-in to SMS when they sign their agreement and leads submit their phone number online to receive more information on membership offers. Leads can sign up for a newsletter and contact the gym using this form - https://exampleforms.org",
"helpMessage": "Community Health Club: You'\''ll be receiving text alerts from us regarding your account, offers & more. You can contact us at (555) 555-5555. Standard data rates may apply.",
"mnoIDs": [
10035
],
"referenceId": null,
"autoRenewal": true,
"tag": [],
"optinKeywords": "YES,START",
"optoutKeywords": "STOP",
"helpKeywords": "HELP",
"optinMessage": "Community Health Club: You'\''ve successfully opted in to our alerts. At any time, reply STOP to opt-out or HELP for help.",
"optoutMessage": "Community Health Club: You'\''ve been successfully opted out of receiving text alerts. To re-opt in reply START.",
"privacyPolicyLink": "https://communityclub.com/privacy-policy/",
"termsAndConditionsLink": "https://communityclub.com/terms-conditions/",
"embeddedLinkSample": ""
}'
Response
{
"campaignId": "C123ABC",
"mnoMetadata": {
"10035": {
"minMsgSamples": 1,
"reqSubscriberHelp": true,
"reqSubscriberOptout": false,
"brandDailyCap": 2000,
"reqSubscriberOptin": true,
"mnoReview": false,
"mnoSupport": true,
"brandTier": "LOW",
"noEmbeddedLink": false,
"noEmbeddedPhone": false,
"qualify": true,
"mno": "T-Mobile"
}
}
}