LogoLogo
No-code docsResources
  • ๐Ÿ–ฅ๏ธWelcome to the Bird API Docs
  • API Access
    • Access Policies
    • Access Roles
    • API Authorization
    • Common API usage
  • Conversations API
    • API reference
      • Channel configuration
        • Get conversations configuration
        • Update conversations configuration
      • Conversations messaging
        • Create conversation message
        • List conversation messages
        • Get conversation message
        • Update conversation message
        • Delete conversation message
        • Create pre-signed upload
      • Conversations management
        • Create conversation
        • List conversations
        • Get conversation
        • Update conversation
        • Delete conversation
      • Conversation Participants
        • Add participant to conversation
        • List participants
        • Get participant by ID
        • Get participant by identifier key and value
        • Update participant by ID
        • Update participant by identifier key and value
        • Delete participant
        • List participant conversations by ID
        • List participant conversations by identifier key and value
      • Workspace settings
        • Get antispam setting
        • Update antispam setting
        • Create allow/block rule
        • Get allow/block rule
        • List allow/block rules
        • Update allow/block rule
        • Delete allow/block rule
        • Add allow/block rules in bulk
        • Get allow/block bulk upload status
      • Events
  • Collaborations API
    • API reference
      • Agent Management
      • Team Management
      • Feeds
      • Feed item activity
      • Tags
      • Automation Rules
      • Business Hours
      • Capacity Rules
      • Routing Queues
      • Skills
      • SLA Policies
      • Macros
      • Sender Profiles
      • Ticket fields
  • Channels API
    • Supported channels
      • Programmable WhatsApp
        • Sending WhatsApp messages
        • Customer service window
        • Receiving messages
        • Message interactions
        • WhatsApp ISV integration
          • Setting up your customer workspaces
            • API Access
            • Associating your Facebook solution ID and business ID with your Bird CRM Organization
            • Creating a workspace for your customer
            • Buying a number through Bird
            • Subscribing to channel created webhooks
          • WhatsApp channel onboarding
            • Setting up the WhatsApp Embedded flow
            • Install WhatsApp phone number in Bird CRM
            • Subscribe to channel webhooks
      • Programmable SMS
        • Installing an SMS channel
          • US 10DLC API Installation
          • Toll-Free Numbers Verification API
        • Sending SMS messages
        • Receiving messages
        • Twilio Exit API
          • Using Twilio PHP SDK
          • Using Twilio Go SDK
          • Using Twilio Ruby SDK
        • Sinch Exit API
      • Programmable RCS
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Email
        • Sending Emails
        • Receiving messages
        • Message status
        • Message interactions
      • Programmable Line
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Telegram
        • Sending messages
        • Receiving messages
        • Message interactions
    • Message types
      • Text
      • Images
      • Files
      • List
      • Carousel
      • Template
    • Message status and interactions
      • Message Failure Codes
      • Message Failure Sources
        • SMS Platform Extended Error Codes
    • Send batch messages
    • API reference
      • Channel Groups
      • Messaging
      • Channels management
      • Channel connectors
      • Navigators
      • Compliance Keywords Messages
      • Conversions Sharing
      • Events
    • Rate Limit
  • Voice API
    • Installing a Voice channel
    • Voice Calls API
      • Initiate an outbound call
      • List calls from a channel
      • Get a call
      • Update a call
      • Answer a call
      • Ring a call
      • Hangup a call
      • Play a message in a call
      • Say Text-To-Speech (TTS)
      • Gather DTMF from a call
      • Forward a call
      • Record a Call
      • Record a call session
      • Update a call recording
      • List call recordings of a call
      • Get a call recording
      • Get a call insights
      • Get calls log
    • Recordings API
      • List Recordings
      • Get a Recording
      • Delete a Recording
      • List recording storage metrics
    • Transcriptions API
      • Initiate a Transcription
      • List Transcriptions
      • Get a Transcription
      • Delete a Transcription
    • Voice webhooks
    • Flash Calling API
  • Verify API
    • Verify API: Quick Start
  • Contacts API
    • Tracking Contact Events
      • API Reference
        • Get configuration
        • Track events
    • API reference
      • Manage workspace contacts
        • Create a contact
        • Get a contact
        • List contacts
        • Search contact by identifier
        • Update a contact
        • Create or update a contact by identifier
        • Delete a contact
      • Manage contact identifiers
        • Create contact identifier
        • List contact identifiers
        • Delete contact identifier
      • Manage contact attribute definition
        • Create attribute definition
        • Get attribute definition
        • List attribute definitions
      • Manage contact lists
        • Create a list
        • Get a list
        • List lists
        • Update a list
        • Delete a list
        • Add contacts to a list
        • Get contact list memberships
        • List contacts in a list
        • Remove contacts from a list
      • Lookup
        • Network/Country information for a phone number
  • Numbers API
    • API reference
      • Search Available Numbers
      • Buy a Number
      • List your Numbers
      • Get Long Code Number Details
      • Manage Endpoint Subscriptions
        • Cancel Number Subscription
      • Manage Endpoint Compliance Requirements
        • List Workspace compliace Requirements
        • Get Workspace Compliace Requirements
        • Update Workspace Compliace Requirements
      • 10DLC Compliance
        • Brands - Organization
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
        • Brands - workspace
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
          • List brand vettings
        • Campaigns
          • Optional: acting as Reseller
          • Create a campaign
          • List all campaigns
          • Get a campaign
          • Update a campaign
          • Delete a campaign
        • TCR Enums
        • Events
      • Toll-Free Numbers Verification API
      • Long Code Numbers
      • Short Code Numbers
      • Alphanumeric Senders
      • Events
  • Know-Your-Customer (KYC) API
    • List KYC forms
    • Get KYC form
    • Create KYC form entry
    • Update KYC form entry
    • List KYC form entries
    • Get a KYC form entry details
  • Reporting API
    • API reference
      • Channel Metrics
      • Flow Run Metrics
      • Wallet Metrics
      • Campaign Metrics
      • Message Metrics
  • Accounts API
    • API reference
      • Current user
        • Change password
        • Presigned upload
        • Memberships
        • Sessions
        • Configurations
          • Groups
            • Keys
      • IAM policies
      • Organizations
        • Upload media
        • Profile
        • Workspaces
        • Users
        • Access keys
        • Organization roles
        • Organization policies
        • Teams
          • Members
        • Approvals
          • Runs
            • Reviews
        • Configurations
          • Groups
            • Keys
      • Region groups
  • Touchpoints API
    • Supported Projects
      • Whatsapp Approved Message Templates
        • Creating WhatsApp Message templates
          • Text template blocks
          • Blocks Documentation
    • API reference
      • Projects
      • Message Templates
  • Notifications API
    • API Reference
      • Webhook subscriptions
        • Create a webhook subscription
        • List available webhook events
        • Get a webhook subscription
        • List webhook subscriptions
        • Update a webhook subscription
        • Delete a webhook subscription
        • Verifying a webhook subscription
        • Webhook subscription logs
  • Knowledge Base (KB) API
    • API reference
      • Documents
      • Folders
        • Import
      • Search
      • Presigned upload
  • Email API
    • Transmissions
  • Connectivity platform migration guide
    • Channels API and Conversations API
    • Migrating conversations API actions
    • Migrating WhatsApp channels
  • Client SDKs
    • Applications
    • Contact Profiles
      • Signed Identity
    • Push notifications
      • Quick Start
      • Subscribe contacts to push notification campaigns
      • Notification Display Priority
    • Event Tracking
      • Quick Start
      • Track Events
        • App
        • Audiences
        • Conference
        • Ecommerce
        • Hospitality
        • Lists
        • Messaging
        • Payments
        • Subscription
        • Suppressions
        • Survey
        • Web
    • App Inbox
      • Quick Start
      • Usage
      • Subscribe contacts to app inbox campaigns
    • SDK Integration
      • Android SDK
        • Notification Interactions
      • Swift SDK
        • Notification Interactions
      • Web SDK
        • Quick Start
        • Usage
        • API Reference
          • IdentityManager
          • BirdSdkApi
          • BirdTracker
            • Ecommerce
            • Conference
            • Messaging
            • Suppressions
            • Subscription
            • Survey
            • Web
            • Audiences
        • Web Push Notifications
          • Notification Interactions
  • Quickstarts
    • Conversations
    • Send an SMS message
    • Send an Email message
    • Send a WhatsApp message
Powered by GitBook
On this page

Was this helpful?

  1. Numbers API
  2. API reference
  3. 10DLC Compliance
  4. Brands - workspace

Create a brand

Last updated 1 year ago

Was this helpful?

A successful request to this endpoint will mean you are charged a fee. If you later need to update or resubmit your brand there may be additional fees.

BrandRequest Object

Field
Type
Description
Mandatory

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

email

string

Valid email address of brand support contact

Required

stockSymbol

Stock symbol

Required for entityType PUBLIC

stockExchange

Stock exchange

Required for entityType PUBLIC

website

string

Brand website URL

Required

vertical

Vertical or industry segment of the brand

Required

altBusinessId

string

Alternate business identifer

Optional

altBusinessIdType

Alternate business identifier type

Required if altBusinessId is provided

BrandResponse Object

Field
Type
Description

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

email

string

Valid email address of brand support contact

stockSymbol

Stock symbol

stockExchange

Stock exchange

website

string

Brand website URL

vertical

Vertical or industry segment of the brand

altBusinessId

string

Alternate business identifier

altBusinessIdType

Alternate business identifier type

brandId

string

UUID of a brand

status

Brand status

  • POSTCreate a brand at workspace level
  • BrandRequest Object
  • BrandResponse Object
entityType
stockSymbol
stockExchange
vertical
altBusinessIdType
entityType
stockSymbol
stockExchange
vertical
altBusinessIdType
status

Create a brand at workspace level

post

Create a brand at workspace level. This means it will be available only for this workspace. A brand registration is mandatory due to compliance requirements.

Authorizations
Path parameters
workspaceIdstring ยท uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e
Body
entityTypestring ยท enumRequired

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 ยท min: 1 ยท max: 255Required

Display or marketing name your brand.

Example: ABC Mobile
companyNamestring ยท min: 1 ยท max: 255Required

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

Example: ABC Inc.
einstring ยท min: 1 ยท max: 21Required

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

Example: 111111111
einIssuingCountrystring ยท min: 1 ยท max: 2Required

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

Example: US
phonestring ยท min: 1 ยท max: 20Required

Valid phone number in e.164 international format.

Example: +12024567890
streetstring ยท min: 1 ยท max: 100Required

Street number and name.

Example: 123 6th Ave
citystring ยท min: 1 ยท max: 100Required

City name

Example: New York
statestring ยท min: 1 ยท max: 20Required

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

Example: NY
postalCodestring ยท min: 1 ยท max: 10Required

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

Example: 10001
countrystring ยท min: 1 ยท max: 2Required

ISO 2 character country code.

Example: US
emailstring ยท min: 1 ยท max: 100Required

Valid email address of brand support contact.

Example: johndoe@abc.com
stockSymbolstring ยท max: 10Optional

Stock symbol. Required for entityType PUBLIC.

Example: ABC
stockExchangestring ยท enumOptional

Stock exchange. Required for entityType PUBLIC.

Example: NASDAQPossible values:
websitestring ยท min: 1 ยท max: 100Required

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.

altBusinessIdTypestring ยท enumOptional

Alternate business identifier type. Required if altBusinessId is provided.

Possible values:
businessContactEmailone ofOptional

Business contact email.

string ยท emailOptional
or
stringOptional
Responses
201
Brand successfully created
application/json
422
Invalid brand
application/json
post
POST /workspaces/{workspaceId}/tcr-brands 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": "+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",
  "businessContactEmail": "name@gmail.com"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-09T05:23:32.247Z",
  "updatedAt": "2025-05-09T05:23:32.247Z",
  "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",
  "businessContactEmail": "name@gmail.com",
  "businessContactEmailVerifiedDate": "2025-05-09T05:23:32.247Z",
  "workspaceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "rejection": {
    "description": "text",
    "code": "text"
  }
}
brand registration