> This page is for APIs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# Create brand

POST https://%7BYour_Space_Name%7D.signalwire.com/api/relay/rest/registry/beta/brands
Content-Type: application/json

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).

Reference: https://signalwire.com/docs/apis/rest/campaign-registry/brands/create-brand

## Authentication

- `Authorization` header (basic auth, required) — 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

### Body (application/json)

This endpoint expects a Campaign Registry: Brands_create_brand_Request.

- `Campaign Registry: Brands_create_brand_Request`
  - CreateManagedBrandRequest: CreateManagedBrandRequest
  - CreateCspBrandRequest: CreateCspBrandRequest

## Response

### 201

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

- `id` (string, required) — The unique identifier of the brand.
- `state` (string, optional) — The current state of the brand.
- `name` (string, optional) — Brand/Marketing/DBA name of the business if applicable.
- `company_name` (string, optional) — The legal name of the business.
- `contact_email` (string, optional) — A company contact email for this brand.
- `contact_phone` (string, optional) — A contact phone number for this brand.
- `signalwire_contact_emails` (list of string, optional) — Email addresses SignalWire uses for registration correspondence about this brand and its campaigns. Defaults to the first administrator on the account.
- `ein_issuing_country` (string, optional) — Country of registration.
- `legal_entity_type` (string, optional) — What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT)
- `ein` (string, optional) — Company EIN Number/Tax ID.
- `company_address` (string, optional) — Full company address.
- `company_vertical` (string, optional) — 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_website` (string, optional) — Link to the company website.
- `csp_brand_reference` (string, optional) — If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit).
- `csp_self_registered` (boolean, optional) — This value must be true for all self-registered brands.
- `status_callback_url` (string, optional) — Optional: Specify a URL to receive webhook notifications when your brand's state changes. See the [10DLC status callback](/docs/apis/rest/webhooks/ten-dlc-status-callback) docs for the webhook payload.
- `created_at` (datetime, optional) — Timestamp when the brand was created.
- `updated_at` (datetime, optional) — Timestamp when the brand was last updated.

## Errors

### 401 Unauthorized Error

Access is unauthorized.

- `error` (enum, required)
  - Allowed values: `Unauthorized`

### 422 Unprocessable Entity Error

The request failed validation. See errors for details.

- `errors` (list of Types.StatusCodes.SpaceApiErrorItem, required) — List of validation errors.

### 500 Internal Server Error

An internal server error occurred.

- `error` (enum, required)
  - Allowed values: `Internal Server Error`

## Types

### CreateManagedBrandRequest

Request body for registering a new managed brand for 10DLC registration.

- `name` (string, required) — Brand/Marketing/DBA name of the business.
- `company_name` (string, required) — The legal name of the business.
- `contact_email` (string, required) — A company contact email for this brand.
- `contact_phone` (string, required) — A contact phone number for this brand.
- `ein_issuing_country` (string, required) — Country of registration.
- `legal_entity_type` (enum, required) — What type of legal entity is the organization?
  - Allowed values: `PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `NON_PROFIT`, `GOVERNMENT`
- `ein` (string, required) — Company EIN Number/Tax ID.
- `company_address` (string, required) — Full company address.
- `company_website` (string, required) — Link to the company website.
- `company_vertical` (enum, optional) — An optional Vertical for the brand.
  - Allowed values: `AGRICULTURE`, `COMMUNICATION`, `CONSTRUCTION`, `EDUCATION`, `ENERGY`, `ENTERTAINMENT`, `FINANCIAL`, `GAMBLING`, `GOVERNMENT`, `HEALTHCARE`, `HOSPITALITY`, `HUMAN_RESOURCES`, `INSURANCE`, `LEGAL`, `MANUFACTURING`, `NGO`, `POLITICAL`, `POSTAL`, `PROFESSIONAL`, `REAL_ESTATE`, `RETAIL`, `TECHNOLOGY`, `TRANSPORTATION`
- `signalwire_contact_emails` (list of string, optional) — Email addresses SignalWire uses for registration correspondence about this brand and its campaigns. Defaults to the first administrator on the account.
- `status_callback_url` (string, optional) — Specify a URL to receive webhook notifications when your brand's state changes. See the [10DLC status callback](/docs/apis/rest/webhooks/ten-dlc-status-callback) docs for the webhook payload.

### CreateCspBrandRequest

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

- `csp_self_registered` (boolean, required) — Set to true to indicate this is a self-registered CSP brand.
- `name` (string, required) — Brand/Marketing/DBA name of the business.
- `csp_brand_reference` (string, required) — The approved Brand ID from TCR. Required for CSP/self-registered brands.
- `signalwire_contact_emails` (list of string, optional) — Email addresses SignalWire uses for registration correspondence about this brand and its campaigns. Defaults to the first administrator on the account.
- `status_callback_url` (string, optional) — Specify a URL to receive webhook notifications when your brand's state changes. See the [10DLC status callback](/docs/apis/rest/webhooks/ten-dlc-status-callback) docs for the webhook payload.

### Types.StatusCodes.SpaceApiErrorItem

Details about a specific validation error.

- `detail` (string, required) — A description of what caused the error.
- `status` (string, required) — The HTTP status code.
- `title` (string, required) — A short summary of the error type.
- `code` (string, required) — The error code.

## Examples

**Request**

```json
{
  "company_address": "123 Brand St, Hill Valley CA, 91905",
  "company_name": "BrandCo",
  "company_website": "www.example.com",
  "contact_email": "brand_info@example.com",
  "contact_phone": "+18995551212",
  "ein": "12-3456789",
  "ein_issuing_country": "United States",
  "legal_entity_type": "PRIVATE_PROFIT",
  "name": "My Brand"
}
```

**Response**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "pending",
  "name": "My Brand",
  "company_name": "BrandCo",
  "contact_email": "brand_info@example.com",
  "contact_phone": "+18995551212",
  "signalwire_contact_emails": [
    "brand_registrations@example.com"
  ],
  "ein_issuing_country": "United States",
  "legal_entity_type": "Private Company",
  "ein": "12-3456789",
  "company_address": "123 Brand St, Hill Valley CA, 91905",
  "company_vertical": "Healthcare",
  "company_website": "www.example.com",
  "csp_brand_reference": "string",
  "csp_self_registered": false,
  "status_callback_url": "https://example.com/handle_callback",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands"

payload = {
    "company_address": "123 Brand St, Hill Valley CA, 91905",
    "company_name": "BrandCo",
    "company_website": "www.example.com",
    "contact_email": "brand_info@example.com",
    "contact_phone": "+18995551212",
    "ein": "12-3456789",
    "ein_issuing_country": "United States",
    "legal_entity_type": "PRIVATE_PROFIT",
    "name": "My Brand"
}
headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<project_id>", "<api_token>"))

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands';
const credentials = btoa("<project_id>:<api_token>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"company_address":"123 Brand St, Hill Valley CA, 91905","company_name":"BrandCo","company_website":"www.example.com","contact_email":"brand_info@example.com","contact_phone":"+18995551212","ein":"12-3456789","ein_issuing_country":"United States","legal_entity_type":"PRIVATE_PROFIT","name":"My Brand"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands"

	payload := strings.NewReader("{\n  \"company_address\": \"123 Brand St, Hill Valley CA, 91905\",\n  \"company_name\": \"BrandCo\",\n  \"company_website\": \"www.example.com\",\n  \"contact_email\": \"brand_info@example.com\",\n  \"contact_phone\": \"+18995551212\",\n  \"ein\": \"12-3456789\",\n  \"ein_issuing_country\": \"United States\",\n  \"legal_entity_type\": \"PRIVATE_PROFIT\",\n  \"name\": \"My Brand\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.SetBasicAuth("<project_id>", "<api_token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<project_id>", "<api_token>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_address\": \"123 Brand St, Hill Valley CA, 91905\",\n  \"company_name\": \"BrandCo\",\n  \"company_website\": \"www.example.com\",\n  \"contact_email\": \"brand_info@example.com\",\n  \"contact_phone\": \"+18995551212\",\n  \"ein\": \"12-3456789\",\n  \"ein_issuing_country\": \"United States\",\n  \"legal_entity_type\": \"PRIVATE_PROFIT\",\n  \"name\": \"My Brand\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands")
  .basicAuth("<project_id>", "<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_address\": \"123 Brand St, Hill Valley CA, 91905\",\n  \"company_name\": \"BrandCo\",\n  \"company_website\": \"www.example.com\",\n  \"contact_email\": \"brand_info@example.com\",\n  \"contact_phone\": \"+18995551212\",\n  \"ein\": \"12-3456789\",\n  \"ein_issuing_country\": \"United States\",\n  \"legal_entity_type\": \"PRIVATE_PROFIT\",\n  \"name\": \"My Brand\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands', [
  'body' => '{
  "company_address": "123 Brand St, Hill Valley CA, 91905",
  "company_name": "BrandCo",
  "company_website": "www.example.com",
  "contact_email": "brand_info@example.com",
  "contact_phone": "+18995551212",
  "ein": "12-3456789",
  "ein_issuing_country": "United States",
  "legal_entity_type": "PRIVATE_PROFIT",
  "name": "My Brand"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<project_id>', '<api_token>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands");
client.Authenticator = new HttpBasicAuthenticator("<project_id>", "<api_token>");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"company_address\": \"123 Brand St, Hill Valley CA, 91905\",\n  \"company_name\": \"BrandCo\",\n  \"company_website\": \"www.example.com\",\n  \"contact_email\": \"brand_info@example.com\",\n  \"contact_phone\": \"+18995551212\",\n  \"ein\": \"12-3456789\",\n  \"ein_issuing_country\": \"United States\",\n  \"legal_entity_type\": \"PRIVATE_PROFIT\",\n  \"name\": \"My Brand\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<project_id>:<api_token>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [
  "company_address": "123 Brand St, Hill Valley CA, 91905",
  "company_name": "BrandCo",
  "company_website": "www.example.com",
  "contact_email": "brand_info@example.com",
  "contact_phone": "+18995551212",
  "ein": "12-3456789",
  "ein_issuing_country": "United States",
  "legal_entity_type": "PRIVATE_PROFIT",
  "name": "My Brand"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```