Skip to main content

Update Brand

PUT 
/brand/:brandId

Update a brand's attributes by brandId.

Request

Path Parameters

    brandId Brandidrequired

Body

required

    entityType EntityTyperequired

    Possible values: [PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT]

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

    displayName Displayname (string)required

    Possible values: <= 100 characters

    Display or marketing name of the brand.

    companyName Companyname (string)

    Possible values: <= 100 characters

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

    firstName Firstname (string)

    Possible values: <= 100 characters

    First name of business contact.

    lastName Lastname (string)

    Possible values: <= 100 characters

    Last name of business contact.

    ein Ein (string)

    Possible values: <= 20 characters

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

    phone Phone (string)

    Possible values: <= 20 characters

    Valid phone number in e.164 international format.

    street Street (string)

    Possible values: <= 100 characters

    Street number and name.

    city City (string)

    Possible values: <= 100 characters

    City name

    state State (string)

    Possible values: <= 20 characters

    State. Must be 2 letters code for United States.

    postalCode Postalcode (string)

    Possible values: <= 10 characters

    Postal codes. Use 5 digit zipcode for United States

    country Country (string)required

    Possible values: <= 2 characters

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

    email Email (string)required

    Possible values: <= 100 characters

    Valid email address of brand support contact.

    stockSymbol Stocksymbol (string)

    Possible values: <= 10 characters

    (Required for public company) stock symbol.

    stockExchange StockExchange

    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.

    ipAddress Ipaddress (string)

    Possible values: <= 50 characters

    IP address of the browser requesting to create brand identity.

    website Website (string)

    Possible values: <= 100 characters

    Brand website URL.

    vertical Verticalrequired

    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.

    altBusiness_id Altbusiness Id (string)

    Possible values: <= 50 characters

    Alternate business identifier such as DUNS, LEI, or GIIN

    altBusinessIdType AltBusinessIdType

    Possible values: [NONE, DUNS, GIIN, LEI]

    An enumeration.

    isReseller Isreseller (boolean)
    identityStatus BrandIdentityStatus

    Possible values: [VERIFIED, UNVERIFIED, SELF_DECLARED, VETTED_VERIFIED]

    The verification status of an active brand

    businessContactEmail BusinessContactEmail (string)

    Business contact email.

    Required if entityType will be changed to PUBLIC_PROFIT.

    webhookURL WebhookURL (string)

    Webhook URL for brand status updates.

    webhookFailoverURL WebhookFailoverURL (string)

    Webhook failover URL for brand status updates.

Responses

200: Successful Response

422: Validation Error

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"
}