Update a brand
Last updated
Last updated
A successful request to this endpoint will mean you may be charged a fee
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
website
string
Brand website URL
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
BrandResponse object describes a submitted brand
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.
A unique identifier for the brand.
Legal entity type. It can't be updated when the brand is approved.
"PRIVATE_PROFIT"
First or given name. Applicable to entity type.
"John"
Last or Surname. Applicable to entity type.
"Doe"
Display or marketing name your brand.
"ABC Mobile"
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.
"ABC Inc."
Government assigned corporate tax ID. EIN is 9-digits in the U.S. It can't be updated when the brand is approved.
"111111111"
The 2 letter ISO country of registration submitted with your EIN / Tax ID registration. It can't be updated when the brand is approved.
"US"
Valid phone number in e.164 international format.
"+12024567890"
Street number and name.
"123 6th Ave"
City name
"New York"
State. Must be a 2 letter state code for US states.
"NY"
Postal code. Must be a 5 digit zip code for the United States.
"10001"
ISO 2 character country code.
"US"
Valid email address of brand support contact.
"johndoe@abc.com"
Stock symbol. Required if updating stockExchange.
"ABC"
Stock exchange. Required for entityType PUBLIC.
"NASDAQ"
Brand website URL.
"https://example.com"
Vertical or industry segment of the brand.
"RETAIL"
Alternate business identifier such as DUNS, LEI, or GIIN
Alternate business identifier type. Required if altBusinessId is provided.
Business contact email.
Brand successfully updated
The ID of the number.
Timestamp (UTC) when the brand was created.
Timestamp (UTC) when the brand was last updated.
Brand status
"PENDING"
Legal entity type. It can't be updated when the brand is approved.
"PRIVATE_PROFIT"
First or given name. Applicable to entity type.
"John"
Last or Surname. Applicable to entity type.
"Doe"
Display or marketing name your brand.
"ABC Mobile"
Legal company name. This should match the legal company name used to register your EIN/Tax ID.
"ABC Inc."
Government assigned corporate tax ID. EIN is 9-digits in the U.S.
"111111111"
The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.
"US"
Valid phone number in e.164 international format.
"+12024567890"
Street number and name.
"123 6th Ave"
City name
"New York"
State. Must be a 2 letter state code for US states.
"NY"
Postal code. Must be a 5 digit zip code for the United States.
"10001"
ISO 2 character country code.
"US"
Valid email address of brand support contact.
"johndoe@abc.com"
Stock symbol.
"ABC"
Stock exchange. Required for entityType PUBLIC.
"NASDAQ"
Brand website URL.
"https://example.com"
Vertical or industry segment of the brand.
"RETAIL"
Alternate business identifier.
Alternate business identifier type. Required if altBusinessId is provided.
Business contact email.
Timestamp (UTC) when the brand businessContactEmail was verified.
Workspace IDs with access to the brand.
Rejection details