Create a brand
A successful request to this endpoint will mean you are charged a brand registration fee. If you later need to update or resubmit your brand there may be additional fees.
POST
/organizations/{organizationId}/tcr-brands
Create a brand at organization-level. This means it will be available for all workspaces under this organization. A brand registration is mandatory due to compliance requirements.
Payload permintaan
entityType
string
wajib
Legal entity type. It can't be updated when the brand is approved.
Possible values: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT, ``
firstName
string
First or given name. Applicable to entity type.
lastName
string
Last or Surname. Applicable to entity type.
displayName
string
wajib
Display or marketing name your brand.
companyName
string
wajib
Legal company name. This should match the legal company name used to register your EIN/Tax ID.
ein
string
wajib
Government assigned corporate tax ID. EIN is 9-digits in the U.S.
einIssuingCountry
string
wajib
The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.
phone
string
wajib
Valid phone number in e.164 international format.
street
string
wajib
Street number and name.
city
string
wajib
City name
state
string
wajib
State. Must be a 2 letter state code for US states.
postalCode
string
wajib
Postal code. Must be a 5 digit zip code for the United States.
country
string
wajib
ISO 2 character country code.
email
string
wajib
Valid email address of brand support contact.
stockSymbol
string
Stock symbol. Required for entityType PUBLIC.
stockExchange
string
Stock exchange. Required for entityType PUBLIC.
Possible values: 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, ``
website
string
wajib
Brand website URL.
vertical
string
Vertical or industry segment of the brand.
altBusinessId
string
Alternate business identifier.
altBusinessIdType
string
Alternate business identifier type. Required if altBusinessId is provided.
Possible values: NONE, DUNS, GIIN, LEI, ``
businessContactEmail
string
Business contact email.
workspaceIds
array of string
Workspace IDs that will have access to this brand. Required when organizationWide is false or not provided.
organizationWide
boolean
If true, this brand is available to all workspaces in the organization, including newly created workspaces. When true, workspaceIds can be omitted or empty.
Payload respons
id
string
The ID of the number.
tcrBrandId
string
The Campaign Registry brand ID.
organizationId
string
createdAt
string
Timestamp (UTC) when the brand was created.
updatedAt
string
Timestamp (UTC) when the brand was last updated.
status
string
Brand status
Possible values: FAILED, PENDING, REJECTED, APPROVED, DELETED, DRAFT
authPlusStatus
string
Brand Auth+ status
Possible values: NOT_APPLICABLE, NEEDS_CHARGE, NEEDS_TRIGGER, DONE
entityType
string
wajib
Legal entity type. It can't be updated when the brand is approved.
Possible values: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT, ``
firstName
string
First or given name. Applicable to entity type.
lastName
string
Last or Surname. Applicable to entity type.
displayName
string
wajib
Display or marketing name your brand.
companyName
string
wajib
Legal company name. This should match the legal company name used to register your EIN/Tax ID.
ein
string
wajib
Government assigned corporate tax ID. EIN is 9-digits in the U.S.
einIssuingCountry
string
wajib
The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.
phone
string
wajib
Valid phone number in e.164 international format.
street
string
wajib
Street number and name.
city
string
wajib
City name
state
string
wajib
State. Must be a 2 letter state code for US states.
postalCode
string
wajib
Postal code. Must be a 5 digit zip code for the United States.
country
string
wajib
ISO 2 character country code.
email
string
wajib
Valid email address of brand support contact.
stockSymbol
string
Stock symbol.
stockExchange
string
Stock exchange. Required for entityType PUBLIC.
Possible values: 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, ``
website
string
wajib
Brand website URL.
vertical
string
Vertical or industry segment of the brand.
altBusinessId
string
Alternate business identifier.
altBusinessIdType
string
Alternate business identifier type. Required if altBusinessId is provided.
Possible values: NONE, DUNS, GIIN, LEI, ``
businessContactEmail
string
Business contact email.
businessContactEmailVerifiedDate
string
Timestamp (UTC) when the brand businessContactEmail was verified.
rejection
object
Rejection details
Tampilkan atribut turunan
rejection.description
string
wajib
Rejection description
rejection.code
string
Rejection code
workspaceIds
array of string
wajib
organizationWide
boolean
wajib
If true, this brand is available to all workspaces in the organization, including newly created workspaces.
Contoh kode
curl -X POST 'https://api.bird.com/organizations/{organizationId}/tcr-brands' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'BrandRequest object
| Field | Type | Description | Mandatory |
|---|---|---|---|
| entityType | entityType | Legal entity type | Required |
| displayName | string | Display or marketing name your brand | Required for entityType PRIVATE/PUBLIC |
| companyName | string | Legal company name. This should match the legal company name used to register your EIN/Tax ID | Required |
| ein | string | Government assigned corporate tax ID. EIN is 9-digits in the U.S. | Required |
| einIssuingCountry | string | The 2 letter ISO country of registration submitted with your EIN / Tax ID registration | Required |
| phone | string | Valid phone number in e.164 international format. | Required |
| street | string | Street number and name | Required |
| city | string | City name | Required |
| state | string | State. Must be a 2 letter state code for US states | Required |
| postalCode | string | Postal code. Must be a 5 digit zip code for the United States | Required |
| country | string | ISO 2 character country code | Required |
| string | Valid email address of brand support contact | Required | |
| stockSymbol | stockSymbol | Stock symbol | Required for entityType PUBLIC |
| stockExchange | stockExchange | Stock exchange | Required for entityType PUBLIC |
| website | string | Brand website URL | Required |
| vertical | vertical | Vertical or industry segment of the brand | Required |
| altBusinessId | string | Alternate business identifer | Optional |
| altBusinessIdType | altBusinessIdType | Alternate business identifier type | Required if altBusinessId is provided |
| workspaceIds | array<UUID> | An array of valid workspace IDs associated with organisation. Brand will be shared with workspace Ids listed | Required |
BrandResponse object
| Field | Type | Description |
|---|---|---|
| entityType | entityType | Legal 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 |
| string | Valid email address of brand support contact | |
| stockSymbol | stockSymbol | Stock symbol |
| stockExchange | stockExchange | Stock exchange |
| website | string | Brand website URL |
| vertical | vertical | Vertical or industry segment of the brand |
| altBusinessId | string | Alternate business identifier |
| altBusinessIdType | altBusinessIdType | Alternate business identifier type |
| brandId | string | UUID of a brand |
| status | status | Brand status |
| workspaceIds | array<UUID> | An array of valid workspace IDs associated with organisation. Brand will be shared with workspace Ids listed |