Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

The Telnyx-assigned brand identifier.

Body

application/json
display_name
string
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>
Available options:
PRIVATE_PROFIT,
PUBLIC_PROFIT,
NON_PROFIT,
GOVERNMENT,
UNKNOWN
website_url
string<uri>
Minimum string length: 1
Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://
profile_id
string
Maximum string length: 36
identifiers
object

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

addresses
object
contacts
object

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

Response

The updated RCS brand.

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