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

# Update brand

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

Changes the fields of an existing US 10-digit long code (10DLC) brand by ID. Fields you omit keep their current values. A brand's details can only be changed while it is in the `unverified` state: on a `pending` or `completed` brand, only `signalwire_contact_emails` can change, and a request that touches any other field is rejected with `invalid_state`.

#### 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/update-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

### Path parameters

- `id` (string, required) — Unique ID of the brand.

### Body (application/json)

This endpoint expects an object.

- `name` (string, optional) — Brand/Marketing/DBA name of the business.
- `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.
- `ein_issuing_country` (string, optional) — Country of registration.
- `legal_entity_type` (enum, optional) — What type of legal entity is the organization?
  - Allowed values: `PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `NON_PROFIT`, `GOVERNMENT`
- `ein` (string, optional) — Company EIN Number/Tax ID.
- `company_address` (string, optional) — Full company address.
- `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`
- `company_website` (string, optional) — Link to the company website.
- `csp_brand_reference` (string, optional) — The approved Brand ID from TCR, for self-registered CSP brands.
- `signalwire_contact_emails` (list of string, optional) — Email addresses SignalWire uses for registration correspondence about this brand and its campaigns. Omit the field to keep the current list. Send an empty list to remove the addresses, after which correspondence goes 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.

## Response

### 200

The request has succeeded.

- `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`

### 404 Not Found Error

The server cannot find the requested resource.

- `error` (enum, required)
  - Allowed values: `Not Found`

### 422 Unprocessable Entity Error

The request failed validation. See errors for details.

- `errors` (list of object, required) — List of validation errors.
  - `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.

### 500 Internal Server Error

An internal server error occurred.

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

## Examples

**Request**

```json
{}
```

**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/id"

payload = {}
headers = {
    "Content-Type": "application/json"
}

response = requests.put(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/id';
const credentials = btoa("<project_id>:<api_token>");

const options = {
  method: 'PUT',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{}'
};

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/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", 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/id")

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

request = Net::HTTP::Put.new(url)
request.basic_auth("<project_id>", "<api_token>")
request["Content-Type"] = 'application/json'
request.body = "{}"

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.put("https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id")
  .basicAuth("<project_id>", "<api_token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id', [
  'body' => '{}',
  '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/id");
client.Authenticator = new HttpBasicAuthenticator("<project_id>", "<api_token>");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", 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 = [] 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/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```