Skip to main content

Update Brand

PUT 

/brand/:brandId

Update a brand's attributes by brandId.

Request

Path Parameters

    brandId Brandidrequired

Body

required

    entityType object

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

    displayName Displaynamerequired

    Possible values: <= 100 characters

    Display or marketing name of the brand.

    companyName Companyname

    Possible values: <= 100 characters

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

    firstName Firstname

    Possible values: <= 100 characters

    First name of business contact.

    lastName Lastname

    Possible values: <= 100 characters

    Last name of business contact.

    ein Ein

    Possible values: <= 20 characters

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

    phone Phone

    Possible values: <= 20 characters

    Valid phone number in e.164 international format.

    street Street

    Possible values: <= 100 characters

    Street number and name.

    city City

    Possible values: <= 100 characters

    City name

    state State

    Possible values: <= 20 characters

    State. Must be 2 letters code for United States.

    postalCode Postalcode

    Possible values: <= 10 characters

    Postal codes. Use 5 digit zipcode for United States

    country Countryrequired

    Possible values: <= 2 characters

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

    email Emailrequired

    Possible values: <= 100 characters

    Valid email address of brand support contact.

    stockSymbol Stocksymbol

    Possible values: <= 10 characters

    (Required for public company) stock symbol.

    stockExchange object

    (Required for public company) stock exchange.

    ipAddress Ipaddress

    Possible values: <= 50 characters

    IP address of the browser requesting to create brand identity.

    website Website

    Possible values: <= 100 characters

    Brand website URL.

    vertical object

    Vertical or industry segment of the brand or campaign.

    altBusiness_id Altbusiness Id

    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
    identityStatus BrandIdentityStatus

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

    The verification status of an active brand

Responses

200: Successful Response

Schema

    entityType object

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

    cspId Cspid

    Unique identifier assigned to the csp by the registry.

    brandId Brandid

    Unique identifier assigned to the brand by the registry.

    displayName Displaynamerequired

    Possible values: <= 100 characters

    Display or marketing name of the brand.

    companyName Companyname

    Possible values: <= 100 characters

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

    firstName Firstname

    Possible values: <= 100 characters

    First name of business contact.

    lastName Lastname

    Possible values: <= 100 characters

    Last name of business contact.

    ein Ein

    Possible values: <= 20 characters

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

    phone Phone

    Possible values: <= 20 characters

    Valid phone number in e.164 international format.

    street Street

    Possible values: <= 100 characters

    Street number and name.

    city City

    Possible values: <= 100 characters

    City name

    state State

    Possible values: <= 20 characters

    State. Must be 2 letters code for United States.

    postalCode Postalcode

    Possible values: <= 10 characters

    Postal codes. Use 5 digit zipcode for United States

    country Countryrequired

    Possible values: <= 2 characters

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

    email Emailrequired

    Possible values: <= 100 characters

    Valid email address of brand support contact.

    stockSymbol Stocksymbol

    Possible values: <= 10 characters

    (Required for public company) stock symbol.

    stockExchange object

    (Required for public company) stock exchange.

    ipAddress Ipaddress

    Possible values: <= 50 characters

    IP address of the browser requesting to create brand identity.

    website Website

    Possible values: <= 100 characters

    Brand website URL.

    brandRelationship object

    Brand relationship to the CSP.

    vertical Verticalrequired

    Possible values: <= 50 characters

    Vertical or industry segment of the brand.

    altBusinessId Altbusinessid

    Possible values: <= 50 characters

    Alternate business identifier such as DUNS, LEI, or GIIN

    altBusinessIdType AltBusinessIdType

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

    An enumeration.

    universalEin Universalein

    Universal EIN of Brand, Read Only.

    referenceId Referenceid

    Unique identifier Telnyx assigned to the brand - the brandId

    identityStatus BrandIdentityStatus

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

    The verification status of an active brand

    optionalAttributes

    object

    taxExemptStatus Taxexemptstatus

    The tax exempt status of the brand

    mock Mock

    Default value: false

    Mock brand for testing purposes

    mobilePhone Mobilephone

    Possible values: <= 20 characters

    Valid mobile phone number in e.164 international format.

    isReseller Isreseller

    Default value: false

    Indicates whether this brand is known to be a reseller

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...