Design / Brand Use Cases / Create a Brand
Create a Brand
Overview
In this use case, we’ll walk through creating a new brand and registering the brand with The Campaign Registry (TCR).
A brand is the company the end-user (the mobile subscriber) believes to be sending the SMS messages, and is responsible for the messaging content in a campaign.
API Operation
Steps
Call the following endpoint:
POST /v1/brands
- Include details about the brand in the request body (company name, type of business, brand contact details, brand relationship, 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 brand for a public for-profit company.
{
"entityType": "PUBLIC_PROFIT",
"firstName": "John",
"lastName": "Doe",
"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",
"email": "johndoe@abc.com",
"stockSymbol": "ABC",
"stockExchange": "NASDAQ",
"website": "http://www.abcmobile.com",
"brandRelationship": "BASIC_ACCOUNT",
"vertical": "RETAIL"
}
Sample Response
The Brand object is returned. This includes the TCR registration score, details about the brand creation, and the brand details.
{
"status": "0000",
"result": {
"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-20T00:18:06.347Z",
"businessAccountId": "67b25a5e-f90a-4491-9ee4-291ff290c1fe",
"status": "ACTIVE",
"email": "johndoe@abc.com",
"createdAt": "2022-04-20T00:18:06.347Z",
"rejectionReason": "string"
}
}
