Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
display_name
string
required
Required string length: 1 - 100
Required string length: 1 - 100
Available options:
LIMITED_LIABILITY_COMPANY,
SOLE_PROPRIETORSHIP,
PARTNERSHIP,
CORPORATION,
S_CORPORATION
organization_type
enum<string>
required
Available options:
PRIVATE_PROFIT,
PUBLIC_PROFIT,
NON_PROFIT,
GOVERNMENT,
UNKNOWN
website_url
string<uri>
required
Minimum string length: 1
Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://
identifiers
object
required

Named business identifiers. Use the ein key for the required EIN and stock_symbol for a public-profit brand's stock symbol.

addresses
object
required
contacts
object
required

Named business contacts. Use the brand key for the required BRAND contact.

profile_id
string | null

A Messaging Profile owned by the authenticated organization. Agents inherit this value when they do not provide their own profile.

Maximum string length: 36

Response

The brand draft was created.

brand_id
string<uuid>
required
display_name
string
required
organization_type
string
required
website_url
string<uri>
required
Minimum string length: 1
Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://
status
enum<string>
required
Available options:
CREATED,
CONFIGURED,
SUBMITTED,
REVIEWING,
VETTING,
VERIFIED,
REJECTED,
FAILED
profile_id
string | null
required
identifiers
object
required
addresses
object
required
contacts
object
required
capabilities
object
required