Campaign Registry

Fresh

Create brand

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.

CreateManagedBrandRequestobjectRequired

Show 11 properties

OR

CreateCspBrandRequestobjectRequired

Show 4 properties

Response

The request has succeeded and a new resource has been created as a result.

idstringformat: "uuid"

The unique identifier of the brand.

statestring

The current state of the brand.

namestring

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

company_namestring

The legal name of the business.

contact_emailstring

A company contact email for this brand.

contact_phonestring

A contact phone number for this brand.

ein_issuing_countrystring

Country of registration.

legal_entity_typestring

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

einstring

Company EIN Number/Tax ID.

company_addressstring

Full company address.

company_verticalstring

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

Link to the company website.

csp_brand_referencestring

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

csp_self_registeredboolean

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

status_callback_urlstring

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

Timestamp when the brand was created.

updated_atdatetime

Timestamp when the brand was last updated.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

---

List brands

Returns a list of your registered brands for 10DLC.

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)

Query parameters

filter_namestringOptional

The name given to the brand. Will return all Brands containing this value as a substring.

filter_statestringOptional

The state of the brand in the registration process, such as pending or complete. Will return all Brands with this value.

Response

The request has succeeded.

linksobject

Pagination links.

Show 4 properties

datalist of objects

List of brands.

Show 17 properties

Errors

401

Unauthorized Error

500

Internal Server Error

---

Delete phone number assignment

Removes a phone number from a campaign.

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)

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the assigned number.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error