Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Brands

Update Brand

Update a brand's attributes by brandId.

put/10dlc/brand/{brandId}

Path parameters

brandIdstring required

Unique identifier of the brand.

Request body

altBusinessIdstring

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType'NONE' | 'DUNS' | 'GIIN' | 'LEI'

An enumeration.

businessContactEmailstring

Business contact email.

Required if entityType will be changed to PUBLIC_PROFIT. Otherwise, it is recommended to either omit this field or set it to null.

citystring

City name

companyNamestring

(Required for Non-profit/private/public) Legal company name.

countrystring required

ISO2 2 characters country code. Example: US - United States

displayNamestring required

Display or marketing name of the brand.

einstring

(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.

emailstring required

Valid email address of brand support contact.

entityType'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' required

Entity type behind the brand. This is the form of business establishment.

firstNamestring

First name of business contact.

identityStatus'VERIFIED' | 'UNVERIFIED' | 'SELF_DECLARED' | 'VETTED_VERIFIED'

The verification status of an active brand

ipAddressstring

IP address of the browser requesting to create brand identity.

isResellerboolean
lastNamestring

Last name of business contact.

phonestring

Valid phone number in e.164 international format.

postalCodestring

Postal codes. Use 5 digit zipcode for United States

statestring

State. Must be 2 letters code for United States.

stockExchange'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.

stockSymbolstring

(Required for public company) stock symbol.

streetstring

Street number and name.

vertical'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION' required

Vertical or industry segment of the brand or campaign.

webhookFailoverURLstring

Webhook failover URL for brand status updates.

webhookURLstring

Webhook URL for brand status updates.

websitestring

Brand website URL.

Example request

{
  "businessContactEmail": "name@example.com",
  "city": "New York",
  "companyName": "ABC Inc.",
  "country": "US",
  "displayName": "ABC Mobile",
  "ein": "111111111",
  "entityType": "PRIVATE_PROFIT",
  "firstName": "John",
  "lastName": "Smith",
  "phone": "+12024567890",
  "postalCode": "10001",
  "state": "NY",
  "stockExchange": "NASDAQ",
  "stockSymbol": "ABC",
  "street": "123",
  "vertical": "TECHNOLOGY",
  "webhookFailoverURL": "https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6",
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "website": "http://www.abcmobile.com"
}

Response

Successful Response

altBusinessIdstring

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType'NONE' | 'DUNS' | 'GIIN' | 'LEI'

An enumeration.

brandIdstring

Unique identifier assigned to the brand.

brandRelationship'BASIC_ACCOUNT' | 'SMALL_ACCOUNT' | 'MEDIUM_ACCOUNT' | 'LARGE_ACCOUNT' | 'KEY_ACCOUNT' required

Brand relationship to the CSP.

businessContactEmailstring

Business contact email.

Required if entityType is PUBLIC_PROFIT.

citystring

City name

companyNamestring

(Required for Non-profit/private/public) Legal company name.

countrystring required

ISO2 2 characters country code. Example: US - United States

createdAtstring

Date and time that the brand was created at.

cspIdstring

Unique identifier assigned to the csp by the registry.

displayNamestring required

Display or marketing name of the brand.

einstring

(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.

emailstring required

Valid email address of brand support contact.

entityType'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' required

Entity type behind the brand. This is the form of business establishment.

failureReasonsstring

Failure reasons for brand

firstNamestring

First name of business contact.

identityStatus'VERIFIED' | 'UNVERIFIED' | 'SELF_DECLARED' | 'VETTED_VERIFIED'

The verification status of an active brand

ipAddressstring

IP address of the browser requesting to create brand identity.

isResellerboolean

Indicates whether this brand is known to be a reseller

lastNamestring

Last name of business contact.

mobilePhonestring

Valid mobile phone number in e.164 international format.

mockboolean

Mock brand for testing purposes

phonestring

Valid phone number in e.164 international format.

postalCodestring

Postal codes. Use 5 digit zipcode for United States

referenceIdstring

Unique identifier Telnyx assigned to the brand - the brandId

statestring

State. Must be 2 letters code for United States.

status'OK' | 'REGISTRATION_PENDING' | 'REGISTRATION_FAILED'

Status of the brand

stockExchange'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.

stockSymbolstring

(Required for public company) stock symbol.

streetstring

Street number and name.

tcrBrandIdstring

Unique identifier assigned to the brand by the registry.

universalEinstring

Universal EIN of Brand, Read Only.

updatedAtstring

Date and time that the brand was last updated at.

verticalstring required

Vertical or industry segment of the brand.

webhookFailoverURLstring

Failover webhook to which brand status updates are sent.

webhookURLstring

Webhook to which brand status updates are sent.

websitestring

Brand website URL.

Example response

{
  "brandId": "4b20017f-8da9-a992-a6c0-683072fb7729",
  "businessContactEmail": "name@example.com",
  "city": "New York",
  "companyName": "ABC Inc.",
  "country": "US",
  "createdAt": "2021-03-08T17:57:48.801186",
  "displayName": "ABC Mobile",
  "ein": "111111111",
  "entityType": "PRIVATE_PROFIT",
  "firstName": "John",
  "lastName": "Smith",
  "mobilePhone": "+12024567890",
  "phone": "+12024567890",
  "postalCode": "10001",
  "state": "NY",
  "stockExchange": "NASDAQ",
  "stockSymbol": "ABC",
  "street": "123",
  "tcrBrandId": "BBRAND1",
  "updatedAt": "2021-03-08T17:57:48.801186",
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "website": "http://www.abcmobile.com"
}