Create a Brand

companyName  CONDITIONAL

string, max length: 255, min length: 0

Legal name of the business. Not required if entityType is SOLE_PROPRIETOR.

displayName  REQUIRED

string, max length: 255, min length: 0

Display or marketing name for the brand.

ein  CONDITIONAL

string, max length: 9, min length: 9

Employer Identification Number (EIN) assigned to the business. In the United States, an EIN contains 9 digits. Not required if entityType is SOLE_PROPRIETOR.

einIssuingCountry

string

ISO 2-letter country code for the country issuing the Employer Identification Number (EIN).

entityType

string (UUID)

Type of business for the brand. Use the List Brand Entity Types API to retrieve a list of alias values that can be used in this field.

vertical  CONDITIONAL

string

Industry segment for the brand. Not required if entityType is SOLE_PROPRIETOR. Use the List Verticals API to retrieve a list of verticalName values that can be used in this field.

website

string, max length: 100, min length: 0

pattern: ^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$

Website for the brand. Must include http:// or https://.

stockSymbol  CONDITIONAL

string, max length: 10, min length: 0

Stock symbol for the brand. Required if entityType is PUBLIC_PROFIT.

stockExchange  CONDITIONAL

string enum, values: NONE, NASDAQ, NYSE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JPX, JSE, KRX, LON, NSE, OMX, SEHK, SGX, SSE, STO, SWX, SZSE, TSX, TWSE, VSE, OTHER

Stock exchange for the brand. Required if entityType is PUBLIC_PROFIT.

firstName  CONDITIONAL

string, max length: 100, min length: 1

First name of the brand contact. Required if entityType is SOLE_PROPRIETOR.

lastName  CONDITIONAL

string, max length: 100, min length: 0

Last name of the brand contact. Required if entityType is SOLE_PROPRIETOR.

phone  REQUIRED

string, max length: 20, min length: 0

pattern: ^\+?[1-9]\d{1,14}$

Phone number (in E.164 format) for the brand support contact.

email  REQUIRED

string, max length: 100, min length: 0

Email address for the brand support contact.

street  REQUIRED

string, max length: 100, min length: 0

Street number and name.

city  REQUIRED

string, max length: 100, min length: 0

City.

state  REQUIRED

string, max length: 20, min length: 0

State or province. 2-character codes are required for the United States (for example, use CA for California).

postalCode  REQUIRED

string, max length: 10, min length: 0

Zip code or postal code. 5-digit zip codes are required for the United States.

country  REQUIRED

string, max length: 2, min length: 0

ISO 2-character country code. For example, use US for the United States.

brandRelationship  CONDITIONAL

string

Brand’s history with the CSP. Not required if entityType is SOLE_PROPRIETOR. Use the List Brand Relationships API to retrieve a list of alias values that can be used in this field.