Design / Campaign Use Cases / Create a Campaign
Create a Campaign
Overview
In this use case, we’ll walk through creating a new campaign and registering the brand with The Campaign Registry (TCR).
A campaign is a targeted effort to send SMS messages to mobile subscribers for promotional or informational purposes, and is typically referred to as an SMS marketing campaign.
API Operation
Steps
Call the following endpoint:
POST /v1/campaigns
- Include details about the campaign in the request body (brand associated with the campaign, use case, description, sample messages, and so on). For a list of required fields, see the API Reference.
- In the Authorization Header, include your RocketCOMS access token as a Bearer Token.
Sample Request
The following request would create a new campaign with a Marketing use case.
{
"brandId": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
"usecase": "MARKETING",
"subUsecases": [
""
],
"description": "Spring Campaign",
"embeddedLink": false,
"embeddedPhone": false,
"numberPool": false,
"ageGated": false,
"directLending": false,
"subscriberOptin": true,
"subscriberOptout": false,
"subscriberHelp": true,
"sample1": "Sample message",
"sample2": "Sample message",
"sample3": "Sample message",
"sample4": "Sample message",
"sample5": "Sample message",
"messageFlow": "string",
"helpMessage": "string",
"mnoIds": [
"string"
],
"autoRenewal": true,
"affiliateMarketing": false,
"sender": "12345678912",
"campaignName": "Spring Campaign"
}
Sample Response
The Campaign object is returned. This includes the details about the campaign creation, the campaign status, and the campaign details.
{
"status": "0000",
"result": {
"id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
"affiliateMarketing": "false",
"ageGated": false,
"autoRenewal": true,
"description": "string",
"directLending": false,
"embeddedLink": false,
"embeddedPhone": false,
"helpMessage": "string",
"messageFlow": "string",
"mnoIds": [
"string"
],
"numberPool": false,
"sample1": "string",
"sample2": "string",
"sample3": "string",
"sample4": "string",
"sample5": "string",
"status": "ACTIVE",
"subscriberHelp": false,
"subscriberOptin": false,
"subscriberOptout": false,
"lastStatusAt": "2022-04-23T22:52:52.590Z",
"brand": {
"id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
"firstName": "John",
"lastName": "Doe",
"countryCode": "US",
"stockExchange": "NASDAQ",
"stockSymbol": "ABC",
"entityType": "PUBLIC_PROFIT",
"cspId": "4e0c15a5-d798-46ff-8c50-2b30bd597abf",
"displayName": "ABC Mobile",
"companyName": "ABC Inc.",
"ein": "111111111",
"einIssuingCountry": "US",
"phone": "+12024567890",
"street": "123 6th Ave",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"website": "http://www.abcmobile.com",
"brandRelationship": "BASIC_ACCOUNT",
"vertical": "RETAIL",
"universalEin": "111111111",
"registrationScore": 0,
"lastStatus": "633eb3bb-7e78-447b-be04-e234dadfb629",
"lastStatusAt": "2022-04-23T22:52:52.590Z",
"businessAccountId": "67b25a5e-f90a-4491-9ee4-291ff290c1fe",
"status": "ACTIVE",
"email": "johndoe@abc.com",
"createdAt": "2022-04-23T22:52:52.590Z",
"rejectionReason": "string"
},
"cspId": "4e0c15a5-d798-46ff-8c50-2b30bd597abf",
"billedDate": "2022-04-23T22:52:52.590Z",
"endDateTime": "2022-04-23T22:52:52.590Z",
"createdAt": "2022-04-23T22:52:52.590Z",
"businessAccountId": "67b25a5e-f90a-4491-9ee4-291ff290c1fe",
"subUsecases": [
""
],
"usecase": "MARKETING",
"sender": "12345678912",
"campaignName": "Spring Campaign",
"rejectionReason": "string"
}
}
