MessagingCampaign RegistryBrands

Create brand

View as MarkdownOpen in Claude
Submits a business identity for US 10-digit long code (10DLC) brand registration, or imports an approved self-registered Campaign Service Provider brand. Use it as the first Campaign Registry step before [Create campaign](/docs/apis/rest/campaign-registry/campaigns/create-campaign); creating a project or phone number does not register a 10DLC brand. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Messaging_ and _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.
CreateManagedBrandRequestobjectRequired
Request body for registering a new managed brand for 10DLC registration.
OR
CreateCspBrandRequestobjectRequired

Request body for importing a self-registered CSP brand. Use this when you have already registered your brand directly with TCR.

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
The unique identifier of the brand.
statestringOptional
The current state of the brand.
namestringOptional

Brand/Marketing/DBA name of the business if applicable.

company_namestringOptional
The legal name of the business.
contact_emailstringOptional
A company contact email for this brand.
contact_phonestringOptional
A contact phone number for this brand.
ein_issuing_countrystringOptional
Country of registration.
legal_entity_typestringOptional

What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT)

einstringOptional

Company EIN Number/Tax ID.

company_addressstringOptional
Full company address.
company_verticalstringOptional

An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION).

company_websitestringOptional
Link to the company website.
csp_brand_referencestringOptional

If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit).

csp_self_registeredbooleanOptional

This value must be true for all self-registered brands.

status_callback_urlstringOptional

Optional: Specify a URL to receive webhook notifications when your brand’s state changes. See the 10DLC status callback docs for the webhook payload.

created_atdatetimeOptional
Timestamp when the brand was created.
updated_atdatetimeOptional
Timestamp when the brand was last updated.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error