Create Brand - Telnyx

This endpoint is used to create a new brand. A brand is an entity created by The Campaign Registry (TCR) that represents an organization or a company. It is this entity that TCR created campaigns will be associated with. Each brand creation will entail an upfront, non-refundable $4 expense.

curl --location --request POST '/brand' \ --header 'Content-Type: application/json' \ --data-raw '{ "businessContactEmail": "name@example.com", "city": "New York", "companyName": "ABC Inc.", "country": "US", "displayName": "ABC Mobile", "ein": "111111111", "email": "string", "entityType": "PRIVATE_PROFIT", "firstName": "John", "ipAddress": "string", "isReseller": false, "lastName": "Smith", "mobilePhone": "+12024567890", "mock": false, "phone": "+12024567890", "postalCode": "10001", "state": "NY", "stockExchange": "NONE", "stockSymbol": "ABC", "street": "123", "vertical": "REAL_ESTATE", "webhookFailoverURL": "https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6", "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93", "website": "http://www.abcmobile.com" }'

{ "altBusinessId": "string", "altBusinessIdType": "NONE", "brandId": "4b20017f-8da9-a992-a6c0-683072fb7729", "brandRelationship": "BASIC_ACCOUNT", "businessContactEmail": "name@example.com", "city": "New York", "companyName": "ABC Inc.", "country": "US", "createdAt": "2021-03-08T17:57:48.801186", "cspId": "string", "displayName": "ABC Mobile", "ein": "111111111", "email": "string", "entityType": "PRIVATE_PROFIT", "failureReasons": null, "firstName": "John", "identityStatus": "VERIFIED", "ipAddress": "string", "isReseller": false, "lastName": "Smith", "mobilePhone": "+12024567890", "mock": false, "optionalAttributes": { "taxExemptStatus": "string" }, "phone": "+12024567890", "postalCode": "10001", "referenceId": "string", "state": "NY", "status": "OK", "stockExchange": "NONE", "stockSymbol": "ABC", "street": "123", "tcrBrandId": "BBRAND1", "universalEin": "string", "updatedAt": "2021-03-08T17:57:48.801186", "vertical": "string", "webhookFailoverURL": "string", "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93", "website": "http://www.abcmobile.com" }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

businessContactEmail

string

BusinessContactEmail

optional

Business contact email.

Required if entityType is PUBLIC_PROFIT.

Example:

name@example.com

city

string

City

optional

City name

<= 100 characters

Example:

New York

companyName

string

Companyname

optional

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

<= 100 characters

Example:

ABC Inc.

country

string

Country

required

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

<= 2 characters

Example:

displayName

string

Displayname

required

Display name, marketing name, or DBA name of the brand.

<= 100 characters

Example:

ABC Mobile

ein

string

Ein

optional

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

<= 20 characters

Example:

111111111

string

required

Valid email address of brand support contact.

<= 100 characters

entityType

required

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

Allowed values:

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT

Example:

PRIVATE_PROFIT

firstName

string

Firstname

optional

First name of business contact.

<= 100 characters

Example:

John

ipAddress

string

Ipaddress

optional

IP address of the browser requesting to create brand identity.

<= 50 characters

isReseller

boolean

Isreseller

optional

Default:

false

lastName

string

Lastname

optional

Last name of business contact.

<= 100 characters

Example:

Smith

mobilePhone

string

Mobilephone

optional

Valid mobile phone number in e.164 international format.

<= 20 characters

Example:

+12024567890

mock

boolean

Mock

optional

Mock brand for testing purposes. Defaults to false.

Default:

false

phone

string

Phone

optional

Valid phone number in e.164 international format.

<= 20 characters

Example:

+12024567890

postalCode

string

Postalcode

optional

Postal codes. Use 5 digit zipcode for United States

<= 10 characters

Example:

10001

state

string

State

optional

State. Must be 2 letters code for United States.

<= 20 characters

Example:

stockExchange

optional

(Required for public company) stock exchange.

Allowed values:

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSSESTOSWXSZSETSXTWSEVSE

Example:

NASDAQ

stockSymbol

string

Stocksymbol

optional

(Required for public company) stock symbol.

<= 10 characters

Example:

ABC

street

string

Street

optional

Street number and name.

<= 100 characters

Example:

123

vertical

required

Vertical or industry segment of the brand.

Allowed values:

REAL_ESTATEHEALTHCAREENERGYENTERTAINMENTRETAILAGRICULTUREINSURANCEEDUCATIONHOSPITALITYFINANCIALGAMBLINGCONSTRUCTIONNGOMANUFACTURINGGOVERNMENTTECHNOLOGYCOMMUNICATION

Example:

TECHNOLOGY

webhookFailoverURL

string

WebhookFailoverURL

optional

Webhook failover URL for brand status updates.

Example:

https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6

webhookURL

string

WebhookURL

optional

Webhook URL for brand status updates.

Example:

https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93

website

string

Website

optional

Brand website URL.

<= 100 characters

Example:

http://www.abcmobile.com

Examples

Responses

🟢200OK

application/json

Successful Response

Body

Telnyx-specific extensions to The Campaign Registry's `Brand` type

altBusinessId

string

Altbusinessid

optional

Alternate business identifier such as DUNS, LEI, or GIIN

<= 50 characters

altBusinessIdType

optional

An enumeration.

Allowed values:

NONEDUNSGIINLEI

brandId

string

Brandid

optional

Unique identifier assigned to the brand.

Example:

4b20017f-8da9-a992-a6c0-683072fb7729

brandRelationship

required

Brand relationship to the CSP

Allowed values:

BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT

businessContactEmail

string

BusinessContactEmail

optional

Business contact email.

Required if entityType is PUBLIC_PROFIT.

Example:

name@example.com

city

string

City

optional

City name

<= 100 characters

Example:

New York

companyName

string

Companyname

optional

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

<= 100 characters

Example:

ABC Inc.

country

string

Country

required

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

<= 2 characters

Example:

createdAt

string

optional

Date and time that the brand was created at.

Example:

2021-03-08T17:57:48.801186

cspId

string

Cspid

optional

Unique identifier assigned to the csp by the registry.

displayName

string

Displayname

required

Display or marketing name of the brand.

<= 100 characters

Example:

ABC Mobile

ein

string

Ein

optional

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

<= 20 characters

Example:

111111111

string

required

Valid email address of brand support contact.

<= 100 characters

entityType

required

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

Allowed values:

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT

Example:

PRIVATE_PROFIT

failureReasons

optional

Failure reasons for brand

firstName

string

Firstname

optional

First name of business contact.

<= 100 characters

Example:

John

identityStatus

optional

The verification status of an active brand

Allowed values:

VERIFIEDUNVERIFIEDSELF_DECLAREDVETTED_VERIFIED

ipAddress

string

Ipaddress

optional

IP address of the browser requesting to create brand identity.

<= 50 characters

isReseller

boolean

Isreseller

optional

Indicates whether this brand is known to be a reseller

Default:

false

lastName

string

Lastname

optional

Last name of business contact.

<= 100 characters

Example:

Smith

mobilePhone

string

Mobilephone

optional

Valid mobile phone number in e.164 international format.

<= 20 characters

Example:

+12024567890

mock

boolean

Mock

optional

Mock brand for testing purposes

Default:

false

optionalAttributes

object (BrandOptionalAttributes)

optional

taxExemptStatus

string

Taxexemptstatus

optional

The tax exempt status of the brand

phone

string

Phone

optional

Valid phone number in e.164 international format.

<= 20 characters

Example:

+12024567890

postalCode

string

Postalcode

optional

Postal codes. Use 5 digit zipcode for United States

<= 10 characters

Example:

10001

referenceId

string

Referenceid

optional

Unique identifier Telnyx assigned to the brand - the brandId

state

string

State

optional

State. Must be 2 letters code for United States.

<= 20 characters

Example:

status

optional

Status of the brand

Allowed values:

OKREGISTRATION_PENDINGREGISTRATION_FAILED

stockExchange

optional

(Required for public company) stock exchange.

Allowed values:

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSSESTOSWXSZSETSXTWSEVSE

Example:

NASDAQ

stockSymbol

string

Stocksymbol

optional

(Required for public company) stock symbol.

<= 10 characters

Example:

ABC

street

string

Street

optional

Street number and name.

<= 100 characters

Example:

123

tcrBrandId

string

TcrBrandid

optional

Unique identifier assigned to the brand by the registry.

Example:

BBRAND1

universalEin

string

Universalein

optional

Universal EIN of Brand, Read Only.

updatedAt

string

optional

Date and time that the brand was last updated at.

Example:

2021-03-08T17:57:48.801186

vertical

string

Vertical

required

Vertical or industry segment of the brand.

<= 50 characters

webhookFailoverURL

string

WebhookFailoverURL

optional

Failover webhook to which brand status updates are sent.

webhookURL

string

WebhookURL

optional

Webhook to which brand status updates are sent.

Example:

https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93

website

string

Website

optional

Brand website URL.

<= 100 characters

Example:

http://www.abcmobile.com

🟠422Parameter Error