Update a brand

A successful request to this endpoint will mean you may be charged a brand resubmission fee

Update brand in a workspace

A brand cannot be updated if the status is failed. The brand must be resubmitted as new. When a brand is approved or has an approved vetting, then the fields 'companyName', 'entityType', 'ein' and 'einIssuingCountry' cannot be updated. When a brand is rejected all fields can be updated.

PATCH/workspaces/{workspaceId}/tcr-brands/{brandId}

Authorization

Path parameters

workspaceId*string

brandId*string

Body

entityTypeBrandEntityType (enum)

Legal entity type. It can't be updated when the brand is approved.

Example: "PRIVATE_PROFIT"

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT

firstNamestring

First or given name. Applicable to entity type.

Example: "John"

lastNamestring

Last or Surname. Applicable to entity type.

Example: "Doe"

displayNamestring

Display or marketing name your brand.

Example: "ABC Mobile"

companyNamestring

Legal company name. This should match the legal company name used to register your EIN/Tax ID. It can't be updated when the brand is approved.

Example: "ABC Inc."

einstring

Government assigned corporate tax ID. EIN is 9-digits in the U.S. It can't be updated when the brand is approved.

Example: "111111111"

einIssuingCountrystring

The 2 letter ISO country of registration submitted with your EIN / Tax ID registration. It can't be updated when the brand is approved.

Example: "US"

phonestring

Valid phone number in e.164 international format.

Example: "+12024567890"

streetstring

Street number and name.

Example: "123 6th Ave"

citystring

City name

Example: "New York"

statestring

State. Must be a 2 letter state code for US states.

Example: "NY"

postalCodestring

Postal code. Must be a 5 digit zip code for the United States.

Example: "10001"

countrystring

ISO 2 character country code.

Example: "US"

emailstring

Valid email address of brand support contact.

Example: "johndoe@abc.com"

stockSymbolstring

Stock symbol. Required if updating stockExchange.

Example: "ABC"

stockExchangeBrandStockExchange (enum)

Stock exchange. Required for entityType PUBLIC.

Example: "NASDAQ"

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSGXSSESTOSWXSZSETSXTWSEVSEOTHER

websitestring

Brand website URL.

Example: "https://example.com"

verticalstring

Vertical or industry segment of the brand.

Example: "RETAIL"

altBusinessIdstring

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdTypeBrandAltBusinessIdType (enum)

Alternate business identifier type. Required if altBusinessId is provided.

NONEDUNSGIINLEI

Response

Brand successfully updated

Body

idstring (uuid)

The ID of the number.

organizationIdstring (uuid)

createdAtstring (date-time)

Timestamp (UTC) when the brand was created.

updatedAtnullable string (date-time)

Timestamp (UTC) when the brand was last updated.

statusBrandStatus (enum)

Brand status

Example: "PENDING"

FAILEDPENDINGREJECTEDAPPROVEDDELETED

entityType*BrandEntityType (enum)

Legal entity type. It can't be updated when the brand is approved.

Example: "PRIVATE_PROFIT"

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT

firstNamestring

First or given name. Applicable to entity type.

Example: "John"

lastNamestring

Last or Surname. Applicable to entity type.

Example: "Doe"

displayName*string

Display or marketing name your brand.

Example: "ABC Mobile"

companyName*string

Legal company name. This should match the legal company name used to register your EIN/Tax ID.

Example: "ABC Inc."

ein*string

Government assigned corporate tax ID. EIN is 9-digits in the U.S.

Example: "111111111"

einIssuingCountry*string

The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.

Example: "US"

phone*string

Valid phone number in e.164 international format.

Example: "+12024567890"

street*string

Street number and name.

Example: "123 6th Ave"

city*string

City name

Example: "New York"

state*string

State. Must be a 2 letter state code for US states.

Example: "NY"

postalCode*string

Postal code. Must be a 5 digit zip code for the United States.

Example: "10001"

country*string

ISO 2 character country code.

Example: "US"

email*string

Valid email address of brand support contact.

Example: "johndoe@abc.com"

stockSymbolstring

Stock symbol.

Example: "ABC"

stockExchangeBrandStockExchange (enum)

Stock exchange. Required for entityType PUBLIC.

Example: "NASDAQ"

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSGXSSESTOSWXSZSETSXTWSEVSEOTHER

website*string

Brand website URL.

Example: "https://example.com"

verticalstring

Vertical or industry segment of the brand.

Example: "RETAIL"

altBusinessIdstring

Alternate business identifier.

altBusinessIdTypeBrandAltBusinessIdType (enum)

Alternate business identifier type. Required if altBusinessId is provided.

NONEDUNSGIINLEI

workspaceIdsnullable array of string (uuid)

Workspace IDs with access to the brand.

rejectionobject

Rejection details

Request

const response = await fetch('/workspaces/{workspaceId}/tcr-brands/{brandId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-07-27T09:11:26.149Z",
  "updatedAt": "2024-07-27T09:11:26.149Z",
  "status": "PENDING",
  "entityType": "PRIVATE_PROFIT",
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "ABC Mobile",
  "companyName": "ABC Inc.",
  "ein": "111111111",
  "einIssuingCountry": "US",
  "phone": "+12024567890",
  "street": "123 6th Ave",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "johndoe@abc.com",
  "stockSymbol": "ABC",
  "stockExchange": "NASDAQ",
  "website": "https://example.com",
  "vertical": "RETAIL",
  "altBusinessId": "text",
  "altBusinessIdType": "NONE",
  "workspaceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "rejection": {
    "description": "text",
    "code": "text"
  }
}

BrandUpdate object

Field	Type	Description	Mandatory	Editing restrictions
entityType	entityType	Legal entity type	Optional	Yes. If Brand has an Approved campaign or Vetting has been Approved
displayName	string	Display or marketing name your brand	Optional
companyName	string	Legal company name. This should match the legal company name used to register your EIN/Tax ID	Optional	Yes. If Brand has an Approved campaign or Vetting has been Approved
ein	string	Government assigned corporate tax ID. EIN is 9-digits in the U.S.	Optional	Yes. If Brand has an Approved campaign or Vetting has been Approved
einIssuingCountry	string	The 2 letter ISO country of registration submitted with your EIN / Tax ID registration	Optional	Yes. If Brand has an Approved campaign or Vetting has been Approved
phone	string	Valid phone number in e.164 international format.	Optional
street	string	Street number and name	Optional
city	string	City name	Optional
state	string	State. Must be a 2 letter state code for US states	Optional
postalCode	string	Postal code. Must be a 5 digit zip code for the United States	Optional
country	string	ISO 2 character country code	Optional
email	string	Valid email address of brand support contact	Optional
stockSymbol	stockSymbol	Stock symbol	Optional. Required if updating stockExchange
stockExchange	stockExchange	Stock exchange	Optional. Required if updating stockSymbol
website	string	Brand website URL	Optional
vertical	vertical	Vertical or industry segment of the brand	Optional

Field

Type

Description

Mandatory

Editing restrictions

entityType

Legal entity type

Optional

Yes. If Brand has an Approved campaign or Vetting has been Approved

displayName

string

Display or marketing name your brand

Optional

companyName

string

Legal company name. This should match the legal company name used to register your EIN/Tax ID

Optional

Yes. If Brand has an Approved campaign or Vetting has been Approved

ein

string

Government assigned corporate tax ID. EIN is 9-digits in the U.S.

Optional

Yes. If Brand has an Approved campaign or Vetting has been Approved

einIssuingCountry

string

The 2 letter ISO country of registration submitted with your EIN / Tax ID registration

Optional

Yes. If Brand has an Approved campaign or Vetting has been Approved

phone

string

Valid phone number in e.164 international format.

Optional

street

string

Street number and name

Optional

city

string

City name

Optional

state

string

State. Must be a 2 letter state code for US states

Optional

postalCode

string

Postal code. Must be a 5 digit zip code for the United States

Optional

country

string

ISO 2 character country code

Optional

string

Valid email address of brand support contact

Optional

stockSymbol

Stock symbol

Optional. Required if updating stockExchange

stockExchange

Stock exchange

Optional. Required if updating stockSymbol

website

string

Brand website URL

Optional

vertical

Vertical or industry segment of the brand

Optional

BrandResponse object

Type	Description
BrandReponse	BrandResponse object describes a submitted brand

Type

Description

BrandReponse

BrandResponse object describes a submitted brand

Last updated 9 months ago