RELAY RESTCampaign Registry

Create a Brand

View as Markdown

Creates a new brand for 10DLC registration.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

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.
objectRequired
OR
objectRequired

Response

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

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

company_namestring or null
The legal name of the business.
contact_emailstring or null
A company contact email for this brand.
contact_phonestring or null
A contact phone number for this brand.
ein_issuing_countrystring or null
Country of registration.
legal_entity_typestring or null

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

einstring or null

Company EIN Number/Tax ID.

company_addressstring or null
Full company address.
company_verticalstring or null

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_websitestring or null
Link to the company website.
csp_brand_referencestring or null

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

csp_self_registeredboolean or null

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

status_callback_urlstring or null

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_atdatetime or null
Timestamp when the brand was created.
updated_atdatetime or null
Timestamp when the brand was last updated.

Errors