Update a brand

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

Update brand at organization level

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

/organizations/{organizationId}/tcr-brands/{brandId}

Authorizations

useraccessKey

Path parameters

organizationIdstring · uuidrequired

The ID for the organization.

Example: d0b85ccc-b63a-4e81-b698-c359d77d250e

brandIdstringrequired

A unique identifier for the brand.

Body

entityTypestring · enum

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

Example: PRIVATE_PROFIT

Options: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT,

firstNamestring · max: 100

First or given name. Applicable to entity type.

Example: John

lastNamestring · max: 100

Last or Surname. Applicable to entity type.

Example: Doe

displayNamestring · max: 255

Display or marketing name your brand.

Example: ABC Mobile

companyNamestring · max: 255

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: 21

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: 2

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: 20

Valid phone number in e.164 international format.

Example: [phone]

streetstring · max: 100

Street number and name.

Example: 123 6th Ave

citystring · max: 100

City name

Example: New York

statestring · max: 20

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

Example: NY

postalCodestring · max: 10

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

Example: 10001

countrystring · max: 2

ISO 2 character country code.

Example: US

emailstring · max: 100

Valid email address of brand support contact.

Example: [e-mail]

stockSymbolstring · max: 10

Stock symbol. Required if updating stockExchange.

Example: ABC

stockExchangestring · enum

Stock exchange. Required for entityType PUBLIC.

Example: NASDAQ

Options: 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,

websitestring · max: 100

Brand website URL.

Example: https://example.com

verticalstring · max: 50

Vertical or industry segment of the brand.

Example: RETAIL

altBusinessIdstring · max: 50

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdTypestring · enum

Alternate business identifier type. Required if altBusinessId is provided.

Options: NONE, DUNS, GIIN, LEI,

businessContactEmailone of

Business contact email.

workspaceIdsstring · uuid[]

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/tcr-brands/{brandId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"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","altBusinessIdType":"NONE","workspaceIds":[null]}'

200

400

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-21T18:05:46.737Z",
  "updatedAt": "2025-02-21T18:05:46.737Z",
  "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",
  "businessContactEmailVerifiedDate": "2025-02-21T18:05:46.737Z",
  "workspaceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "businessContactEmail": "[e-mail]",
  "rejection": {
    "description": "text",
    "code": "text"
  }
}

Brand successfully updated

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
workspaceIds	array<UUID>	An array of valid workspace IDs associated with organisation. Brand will be shared with workspace Ids listed	Optional. Provide new list to share with different set of workpaces

BrandResonse object

Type	Description
BrandReponse	BrandResponse object describes a submitted brand