Update Brand
PUT/brand/:brandId
Update a brand's attributes by brandId
.
Request
Path Parameters
- application/json
Body
required
Possible values: [PRIVATE_PROFIT
, PUBLIC_PROFIT
, NON_PROFIT
, SOLE_PROPRIETOR
, GOVERNMENT
]
Entity type behind the brand. This is the form of business establishment.
Possible values: <= 100 characters
Display or marketing name of the brand.
Possible values: <= 100 characters
(Required for Non-profit/private/public) Legal company name.
Possible values: <= 100 characters
First name of business contact.
Possible values: <= 100 characters
Last name of business contact.
Possible values: <= 20 characters
(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.
Possible values: <= 20 characters
Valid phone number in e.164 international format.
Possible values: <= 100 characters
Street number and name.
Possible values: <= 100 characters
City name
Possible values: <= 20 characters
State. Must be 2 letters code for United States.
Possible values: <= 10 characters
Postal codes. Use 5 digit zipcode for United States
Possible values: <= 2 characters
ISO2 2 characters country code. Example: US - United States
Possible values: <= 100 characters
Valid email address of brand support contact.
Possible values: <= 10 characters
(Required for public company) stock symbol.
Possible values: [NONE
, NASDAQ
, NYSE
, AMEX
, AMX
, ASX
, B3
, BME
, BSE
, FRA
, ICEX
, JPX
, JSE
, KRX
, LON
, NSE
, OMX
, SEHK
, SSE
, STO
, SWX
, SZSE
, TSX
, TWSE
, VSE
]
(Required for public company) stock exchange.
Possible values: <= 50 characters
IP address of the browser requesting to create brand identity.
Possible values: <= 100 characters
Brand website URL.
Possible values: [REAL_ESTATE
, HEALTHCARE
, ENERGY
, ENTERTAINMENT
, RETAIL
, AGRICULTURE
, INSURANCE
, EDUCATION
, HOSPITALITY
, FINANCIAL
, GAMBLING
, CONSTRUCTION
, NGO
, MANUFACTURING
, GOVERNMENT
, TECHNOLOGY
, COMMUNICATION
]
Vertical or industry segment of the brand or campaign.
Possible values: <= 50 characters
Alternate business identifier such as DUNS, LEI, or GIIN
Possible values: [NONE
, DUNS
, GIIN
, LEI
]
An enumeration.
Possible values: [VERIFIED
, UNVERIFIED
, SELF_DECLARED
, VETTED_VERIFIED
]
The verification status of an active brand
Business contact email.
Required if entityType
will be changed to PUBLIC_PROFIT
.
Webhook URL for brand status updates.
Webhook failover URL for brand status updates.
Responses
200: Successful Response
- application/json
422: Validation Error
- application/json
Request samples
curl -L -X PUT 'https://api.telnyx.com/10dlc/brand/:brandId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"entityType": "PRIVATE_PROFIT",
"displayName": "ABC Mobile",
"companyName": "ABC Inc.",
"firstName": "John",
"lastName": "Smith",
"ein": "111111111",
"phone": "+12024567890",
"street": "123",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"email": "string",
"stockSymbol": "ABC",
"stockExchange": "NASDAQ",
"ipAddress": "string",
"website": "http://www.abcmobile.com",
"vertical": "TECHNOLOGY",
"altBusiness_id": "string",
"isReseller": true,
"businessContactEmail": "name@example.com",
"webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
"webhookFailoverURL": "https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6"
}'
Response samples
{
"entityType": "PRIVATE_PROFIT",
"cspId": "string",
"brandId": "4b20017f-8da9-a992-a6c0-683072fb7729",
"tcrBrandId": "BBRAND1",
"displayName": "ABC Mobile",
"companyName": "ABC Inc.",
"firstName": "John",
"lastName": "Smith",
"ein": "111111111",
"phone": "+12024567890",
"street": "123",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"email": "string",
"stockSymbol": "ABC",
"stockExchange": "NASDAQ",
"ipAddress": "string",
"website": "http://www.abcmobile.com",
"vertical": "string",
"altBusinessId": "string",
"universalEin": "string",
"referenceId": "string",
"optionalAttributes": {
"taxExemptStatus": "string"
},
"mock": false,
"mobilePhone": "+12024567890",
"isReseller": false,
"webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
"businessContactEmail": "name@example.com",
"webhookFailoverURL": "string"
}
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}