Update a brand

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

Update brand in organization

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}
Authorization
Path parameters
organizationId*string
brandId*string
Body
entityTypeBrandEntityType (enum)

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

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT
firstNamestring

First or given name. Applicable to entity type.

lastNamestring

Last or Surname. Applicable to entity type.

displayNamestring

Display or marketing name your brand.

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.

einstring

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

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.

phonestring

Valid phone number in e.164 international format.

streetstring

Street number and name.

citystring

City name

statestring

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

postalCodestring

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

countrystring

ISO 2 character country code.

emailstring

Valid email address of brand support contact.

stockSymbolstring

Stock symbol. Required if updating stockExchange.

stockExchangeBrandStockExchange (enum)

Stock exchange. Required for entityType PUBLIC.

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSGXSSESTOSWXSZSETSXTWSEVSEOTHER
websitestring

Brand website URL.

verticalstring

Vertical or industry segment of the brand.

altBusinessIdstring

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdTypeBrandAltBusinessIdType (enum)

Alternate business identifier type. Required if altBusinessId is provided.

NONEDUNSGIINLEI
workspaceIdsarray of string (uuid)
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

FAILEDPENDINGREJECTEDAPPROVEDDELETED
entityType*BrandEntityType (enum)

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

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT
firstNamestring

First or given name. Applicable to entity type.

lastNamestring

Last or Surname. Applicable to entity type.

displayName*string

Display or marketing name your brand.

companyName*string

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

ein*string

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

einIssuingCountry*string

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

phone*string

Valid phone number in e.164 international format.

street*string

Street number and name.

city*string

City name

state*string

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

postalCode*string

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

country*string

ISO 2 character country code.

email*string

Valid email address of brand support contact.

stockSymbolstring

Stock symbol.

stockExchangeBrandStockExchange (enum)

Stock exchange. Required for entityType PUBLIC.

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSGXSSESTOSWXSZSETSXTWSEVSEOTHER
website*string

Brand website URL.

verticalstring

Vertical or industry segment of the brand.

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

workspaceIds*array of string (uuid)
Request
const response = await fetch('/organizations/{organizationId}/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-04-18T14:21:20.070Z",
  "updatedAt": "2024-04-18T14:21:20.070Z",
  "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

FieldTypeDescriptionMandatoryEditing 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

email

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

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

TypeDescription

BrandResponse object describes a submitted brand

Last updated