# Create a Brand

POST https://YOUR_SPACE.signalwire.com/api/relay/rest/registry/beta/brands
Content-Type: application/json

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](/docs/platform/your-signalwire-api-space).

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /registry/beta/brands:
    post:
      operationId: create-brand
      summary: Create a Brand
      description: >-
        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](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_campaignRegistry
      parameters:
        - name: Authorization
          in: header
          description: >-
            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)

            ```
          required: true
          schema:
            type: string
      responses:
        '201':
          description: >-
            The request has succeeded and a new resource has been created as a
            result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Campaign Registry_create_brand_Request'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    LegalEntityType:
      type: string
      enum:
        - PRIVATE_PROFIT
        - PUBLIC_PROFIT
        - NON_PROFIT
        - GOVERNMENT
      description: Legal entity type for brand registration.
      title: LegalEntityType
    CompanyVertical:
      type: string
      enum:
        - 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
      description: Company vertical/industry classification.
      title: CompanyVertical
    CreateManagedBrandRequest:
      type: object
      properties:
        name:
          type: string
          description: Brand/Marketing/DBA name of the business.
        company_name:
          type: string
          description: The legal name of the business.
        contact_email:
          type: string
          description: A company contact email for this brand.
        contact_phone:
          type: string
          description: A contact phone number for this brand.
        ein_issuing_country:
          type: string
          description: Country of registration.
        legal_entity_type:
          $ref: '#/components/schemas/LegalEntityType'
          description: What type of legal entity is the organization?
        ein:
          type: string
          description: Company EIN Number/Tax ID.
        company_address:
          type: string
          description: Full company address.
        company_vertical:
          $ref: '#/components/schemas/CompanyVertical'
          description: An optional Vertical for the brand.
        company_website:
          type: string
          description: Link to the company website.
        status_callback_url:
          type: string
          format: uri
          description: >-
            Specify a URL to receive webhook notifications when your brand's
            state changes. See the [10DLC status
            callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback)
            docs for the webhook payload.
      required:
        - name
        - company_name
        - contact_email
        - contact_phone
        - ein_issuing_country
        - legal_entity_type
        - ein
        - company_address
        - company_website
      description: Request body for registering a new managed brand for 10DLC registration.
      title: CreateManagedBrandRequest
    CreateCspBrandRequest:
      type: object
      properties:
        csp_self_registered:
          type: boolean
          description: Set to true to indicate this is a self-registered CSP brand.
        name:
          type: string
          description: Brand/Marketing/DBA name of the business.
        csp_brand_reference:
          type: string
          description: >-
            The approved Brand ID from TCR. Required for CSP/self-registered
            brands.
        status_callback_url:
          type: string
          format: uri
          description: >-
            Specify a URL to receive webhook notifications when your brand's
            state changes. See the [10DLC status
            callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback)
            docs for the webhook payload.
      required:
        - csp_self_registered
        - name
        - csp_brand_reference
      description: >-
        Request body for importing a self-registered CSP brand. Use this when
        you have already registered your brand directly with TCR.
      title: CreateCspBrandRequest
    Campaign Registry_create_brand_Request:
      oneOf:
        - $ref: '#/components/schemas/CreateManagedBrandRequest'
        - $ref: '#/components/schemas/CreateCspBrandRequest'
      title: Campaign Registry_create_brand_Request
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    BrandResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the brand.
        state:
          type: string
          description: The current state of the brand.
        name:
          type: string
          description: Brand/Marketing/DBA name of the business if applicable.
        company_name:
          type: string
          description: The legal name of the business.
        contact_email:
          type: string
          description: A company contact email for this brand.
        contact_phone:
          type: string
          description: A contact phone number for this brand.
        ein_issuing_country:
          type: string
          description: Country of registration.
        legal_entity_type:
          type: string
          description: >-
            What type of legal entity is the organization? (PRIVATE_PROFIT,
            PUBLIC_PROFIT, NON_PROFIT)
        ein:
          type: string
          description: Company EIN Number/Tax ID.
        company_address:
          type: string
          description: Full company address.
        company_vertical:
          type: string
          description: >-
            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:
          type: string
          description: Link to the company website.
        csp_brand_reference:
          type: string
          description: >-
            If you are your own Campaign Service Provider, this is the approved
            Brand ID (Mandatory for CSPs, otherwise please omit).
        csp_self_registered:
          type: boolean
          description: This value must be true for all self-registered brands.
        status_callback_url:
          type: string
          description: >-
            Optional: Specify a URL to receive webhook notifications when your
            brand's state changes. See the [10DLC status
            callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback)
            docs for the webhook payload.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the brand was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the brand was last updated.
      required:
        - id
      description: Response containing a single brand.
      title: BrandResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    Types.StatusCodes.SpaceApiErrorItem:
      type: object
      properties:
        detail:
          type: string
          description: A description of what caused the error.
        status:
          type: string
          description: The HTTP status code.
        title:
          type: string
          description: A short summary of the error type.
        code:
          type: string
          description: The error code.
      required:
        - detail
        - status
        - title
        - code
      description: Details about a specific validation error.
      title: Types.StatusCodes.SpaceApiErrorItem
    Types.StatusCodes.ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request failed validation. See errors for details.
      title: Types.StatusCodes.ValidationError
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        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)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/registry/beta/brands"

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

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/registry/beta/brands';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/json'
  },
  body: '{"name":"My Brand","company_name":"BrandCo","contact_email":"brand_info@example.com","contact_phone":"+18995551212","ein_issuing_country":"United States","legal_entity_type":"PRIVATE_PROFIT","ein":"12-3456789","company_address":"123 Brand St, Hill Valley CA, 91905","company_website":"www.example.com"}'
};

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.signalwire.com/api/relay/rest/registry/beta/brands"

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

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

	req.Header.Add("Authorization", "Basic <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.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["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Brand\",\n  \"company_name\": \"BrandCo\",\n  \"contact_email\": \"brand_info@example.com\",\n  \"contact_phone\": \"+18995551212\",\n  \"ein_issuing_country\": \"United States\",\n  \"legal_entity_type\": \"PRIVATE_PROFIT\",\n  \"ein\": \"12-3456789\",\n  \"company_address\": \"123 Brand St, Hill Valley CA, 91905\",\n  \"company_website\": \"www.example.com\"\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.signalwire.com/api/relay/rest/registry/beta/brands")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Brand\",\n  \"company_name\": \"BrandCo\",\n  \"contact_email\": \"brand_info@example.com\",\n  \"contact_phone\": \"+18995551212\",\n  \"ein_issuing_country\": \"United States\",\n  \"legal_entity_type\": \"PRIVATE_PROFIT\",\n  \"ein\": \"12-3456789\",\n  \"company_address\": \"123 Brand St, Hill Valley CA, 91905\",\n  \"company_website\": \"www.example.com\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/registry/beta/brands");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"My Brand\",\n  \"company_name\": \"BrandCo\",\n  \"contact_email\": \"brand_info@example.com\",\n  \"contact_phone\": \"+18995551212\",\n  \"ein_issuing_country\": \"United States\",\n  \"legal_entity_type\": \"PRIVATE_PROFIT\",\n  \"ein\": \"12-3456789\",\n  \"company_address\": \"123 Brand St, Hill Valley CA, 91905\",\n  \"company_website\": \"www.example.com\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.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()
```