Update a brand

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

Update brand by id

patch

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.

Authorizations

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

brandIdstringRequired

A unique identifier for the brand.

Body

entityTypestring · enumOptional

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

Example: PRIVATE_PROFITPossible values:

firstNamestring · max: 100Optional

First or given name. Applicable to entity type.

Example: John

lastNamestring · max: 100Optional

Last or Surname. Applicable to entity type.

Example: Doe

displayNamestring · max: 255Optional

Display or marketing name your brand.

Example: ABC Mobile

companyNamestring · max: 255Optional

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 · max: 21Optional

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 · max: 2Optional

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 · max: 20Optional

Valid phone number in e.164 international format.

Example: [phone]

streetstring · max: 100Optional

Street number and name.

Example: 123 6th Ave

citystring · max: 100Optional

City name

Example: New York

statestring · max: 20Optional

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

Example: NY

postalCodestring · max: 10Optional

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

Example: 10001

countrystring · max: 2Optional

ISO 2 character country code.

Example: US

emailstring · max: 100Optional

Valid email address of brand support contact.

Example: [e-mail]

stockSymbolstring · max: 10Optional

Stock symbol. Required if updating stockExchange.

Example: ABC

stockExchangestring · enumOptional

Stock exchange. Required for entityType PUBLIC.

Example: NASDAQPossible values:

websitestring · max: 100Optional

Brand website URL.

Example: https://example.com

verticalstring · max: 50Optional

Vertical or industry segment of the brand.

Example: RETAIL

altBusinessIdstring · max: 50Optional

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdTypestring · enumOptional

Alternate business identifier type. Required if altBusinessId is provided.

Possible values:

businessContactEmailone ofOptional

Business contact email.

string · emailOptional

or

stringOptional

Responses

200

Brand successfully updated

application/json

400

Unable to update brand

application/json

404

Brand not found

application/json

patch

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/tcr-brands/{brandId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 488

{
  "entityType": "PRIVATE_PROFIT",
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "ABC Mobile",
  "companyName": "ABC Inc.",
  "ein": "111111111",
  "einIssuingCountry": "US",
  "phone": "[phone]",
  "street": "123 6th Ave",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "[e-mail]",
  "stockSymbol": "ABC",
  "stockExchange": "NASDAQ",
  "website": "https://example.com",
  "vertical": "RETAIL",
  "altBusinessId": "text",
  "altBusinessIdType": "NONE",
  "businessContactEmail": "[e-mail]"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-29T07:09:41.386Z",
  "updatedAt": "2025-05-29T07:09:41.386Z",
  "status": "PENDING",
  "entityType": "PRIVATE_PROFIT",
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "ABC Mobile",
  "companyName": "ABC Inc.",
  "ein": "111111111",
  "einIssuingCountry": "US",
  "phone": "[phone]",
  "street": "123 6th Ave",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "[e-mail]",
  "stockSymbol": "ABC",
  "stockExchange": "NASDAQ",
  "website": "https://example.com",
  "vertical": "RETAIL",
  "altBusinessId": "text",
  "altBusinessIdType": "NONE",
  "businessContactEmail": "[e-mail]",
  "businessContactEmailVerifiedDate": "2025-05-29T07:09:41.386Z",
  "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

BrandResponse object

Type	Description
BrandReponse	BrandResponse object describes a submitted brand