Design / Brand Use Cases / Update a Brand
Update a Brand
Overview
In this use case, we’ll walk through updating information for a registered brand.
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:
PUT /v1/brands/{id}
- Use the {id} path parameter to specify the brand ID.
- Include the fields you want to update in the request body. You can update the type of business, the brand contact’s name and phone number, the company’s legal name and display name, the company’s address and website, the Employer Identification Number (EIN) and the EIN issuing country, stock market information, and the industry segment. For a full list of fields, see the API Reference.
- In the Authorization Header, include your RocketCOMS access token as a Bearer Token.
Sample Request
The following request would update the name and contact information for the brand contact.
{
"firstName": "Mary",
"lastName": "Smith",
"phone": "+12029874231",
"email": "marysmith@abc.com",
}
Sample Response
The Brand object is returned with the updated brand details.
{
"status": "0000",
"result": {
"id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
"firstName": "Mary",
"lastName": "Smith",
"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": "+12029874231",
"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": "marysmith@abc.com",
"createdAt": "2022-04-20T00:18:06.347Z",
"rejectionReason": "string"
}
}
