Update a 10DLC Brand

curl --request PUT \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dba_name": "Brand",
  "company_name": "Company",
  "entity_type": "PRIVATE_PROFIT",
  "vertical": "HEALTHCARE",
  "ein_taxid": "999999999",
  "ein_taxid_country": "US",
  "website": "https://brand.com",
  "stock_symbol": "<string>",
  "stock_exchange": "<string>",
  "first_name": "John",
  "last_name": "Dow",
  "phone_number": "12123450099",
  "email": "support@brand.com",
  "street_address": "10, City Name",
  "city": "Miami",
  "state_or_province": "FL",
  "zip": "12346",
  "country": "US",
  "mock": false
}
'

import requests

url = "https://api.wavix.com/v3/10dlc/brands/{brand_id}"

payload = {
    "dba_name": "Brand",
    "company_name": "Company",
    "entity_type": "PRIVATE_PROFIT",
    "vertical": "HEALTHCARE",
    "ein_taxid": "999999999",
    "ein_taxid_country": "US",
    "website": "https://brand.com",
    "stock_symbol": "<string>",
    "stock_exchange": "<string>",
    "first_name": "John",
    "last_name": "Dow",
    "phone_number": "12123450099",
    "email": "support@brand.com",
    "street_address": "10, City Name",
    "city": "Miami",
    "state_or_province": "FL",
    "zip": "12346",
    "country": "US",
    "mock": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dba_name: 'Brand',
    company_name: 'Company',
    entity_type: 'PRIVATE_PROFIT',
    vertical: 'HEALTHCARE',
    ein_taxid: '999999999',
    ein_taxid_country: 'US',
    website: 'https://brand.com',
    stock_symbol: '<string>',
    stock_exchange: '<string>',
    first_name: 'John',
    last_name: 'Dow',
    phone_number: '12123450099',
    email: 'support@brand.com',
    street_address: '10, City Name',
    city: 'Miami',
    state_or_province: 'FL',
    zip: '12346',
    country: 'US',
    mock: false
  })
};

fetch('https://api.wavix.com/v3/10dlc/brands/{brand_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v3/10dlc/brands/{brand_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'dba_name' => 'Brand',
    'company_name' => 'Company',
    'entity_type' => 'PRIVATE_PROFIT',
    'vertical' => 'HEALTHCARE',
    'ein_taxid' => '999999999',
    'ein_taxid_country' => 'US',
    'website' => 'https://brand.com',
    'stock_symbol' => '<string>',
    'stock_exchange' => '<string>',
    'first_name' => 'John',
    'last_name' => 'Dow',
    'phone_number' => '12123450099',
    'email' => 'support@brand.com',
    'street_address' => '10, City Name',
    'city' => 'Miami',
    'state_or_province' => 'FL',
    'zip' => '12346',
    'country' => 'US',
    'mock' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.wavix.com/v3/10dlc/brands/{brand_id}"

	payload := strings.NewReader("{\n  \"dba_name\": \"Brand\",\n  \"company_name\": \"Company\",\n  \"entity_type\": \"PRIVATE_PROFIT\",\n  \"vertical\": \"HEALTHCARE\",\n  \"ein_taxid\": \"999999999\",\n  \"ein_taxid_country\": \"US\",\n  \"website\": \"https://brand.com\",\n  \"stock_symbol\": \"<string>\",\n  \"stock_exchange\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Dow\",\n  \"phone_number\": \"12123450099\",\n  \"email\": \"support@brand.com\",\n  \"street_address\": \"10, City Name\",\n  \"city\": \"Miami\",\n  \"state_or_province\": \"FL\",\n  \"zip\": \"12346\",\n  \"country\": \"US\",\n  \"mock\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.wavix.com/v3/10dlc/brands/{brand_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dba_name\": \"Brand\",\n  \"company_name\": \"Company\",\n  \"entity_type\": \"PRIVATE_PROFIT\",\n  \"vertical\": \"HEALTHCARE\",\n  \"ein_taxid\": \"999999999\",\n  \"ein_taxid_country\": \"US\",\n  \"website\": \"https://brand.com\",\n  \"stock_symbol\": \"<string>\",\n  \"stock_exchange\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Dow\",\n  \"phone_number\": \"12123450099\",\n  \"email\": \"support@brand.com\",\n  \"street_address\": \"10, City Name\",\n  \"city\": \"Miami\",\n  \"state_or_province\": \"FL\",\n  \"zip\": \"12346\",\n  \"country\": \"US\",\n  \"mock\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v3/10dlc/brands/{brand_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dba_name\": \"Brand\",\n  \"company_name\": \"Company\",\n  \"entity_type\": \"PRIVATE_PROFIT\",\n  \"vertical\": \"HEALTHCARE\",\n  \"ein_taxid\": \"999999999\",\n  \"ein_taxid_country\": \"US\",\n  \"website\": \"https://brand.com\",\n  \"stock_symbol\": \"<string>\",\n  \"stock_exchange\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Dow\",\n  \"phone_number\": \"12123450099\",\n  \"email\": \"support@brand.com\",\n  \"street_address\": \"10, City Name\",\n  \"city\": \"Miami\",\n  \"state_or_province\": \"FL\",\n  \"zip\": \"12346\",\n  \"country\": \"US\",\n  \"mock\": false\n}"

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

{
  "brand_id": "BM20QP9",
  "city": "Miami",
  "company_name": "Company legal name",
  "country": "US",
  "created_at": "2024-07-24T08:10:49",
  "dba_name": "New Brand",
  "ein_taxid": "99999999",
  "ein_taxid_country": "US",
  "email": "support@brand.com",
  "entity_type": "PRIVATE_PROFIT",
  "feedback": null,
  "first_name": "John",
  "last_name": "Dow",
  "mock": false,
  "phone_number": "12123450099",
  "state_or_province": "FL",
  "status": "REVIEW",
  "stock_exchange": null,
  "stock_symbol": null,
  "street_address": "10, Street Name",
  "updated_at": "2024-07-24T09:02:19",
  "vertical": "HEALTHCARE",
  "website": "https://brand.com",
  "zip": "12345"
}

{
  "success": false,
  "message": "Missing or invalid parameter <param_name>"
}

{
  "success": false,
  "message": "Request failed. The feature is disabled for the account."
}

{
  "success": false,
  "message": "Request failed. The Brand is not found."
}

{
  "success": false,
  "message": "Invalid ein_taxid - ein_taxid is a nine-digit number. The format is XX-XXXXXXX. The \\\"-\\\" symbol is also accepted."
}

PUT

10dlc

brands

{brand_id}

Update a 10DLC Brand

curl --request PUT \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dba_name": "Brand",
  "company_name": "Company",
  "entity_type": "PRIVATE_PROFIT",
  "vertical": "HEALTHCARE",
  "ein_taxid": "999999999",
  "ein_taxid_country": "US",
  "website": "https://brand.com",
  "stock_symbol": "<string>",
  "stock_exchange": "<string>",
  "first_name": "John",
  "last_name": "Dow",
  "phone_number": "12123450099",
  "email": "support@brand.com",
  "street_address": "10, City Name",
  "city": "Miami",
  "state_or_province": "FL",
  "zip": "12346",
  "country": "US",
  "mock": false
}
'

import requests

url = "https://api.wavix.com/v3/10dlc/brands/{brand_id}"

payload = {
    "dba_name": "Brand",
    "company_name": "Company",
    "entity_type": "PRIVATE_PROFIT",
    "vertical": "HEALTHCARE",
    "ein_taxid": "999999999",
    "ein_taxid_country": "US",
    "website": "https://brand.com",
    "stock_symbol": "<string>",
    "stock_exchange": "<string>",
    "first_name": "John",
    "last_name": "Dow",
    "phone_number": "12123450099",
    "email": "support@brand.com",
    "street_address": "10, City Name",
    "city": "Miami",
    "state_or_province": "FL",
    "zip": "12346",
    "country": "US",
    "mock": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dba_name: 'Brand',
    company_name: 'Company',
    entity_type: 'PRIVATE_PROFIT',
    vertical: 'HEALTHCARE',
    ein_taxid: '999999999',
    ein_taxid_country: 'US',
    website: 'https://brand.com',
    stock_symbol: '<string>',
    stock_exchange: '<string>',
    first_name: 'John',
    last_name: 'Dow',
    phone_number: '12123450099',
    email: 'support@brand.com',
    street_address: '10, City Name',
    city: 'Miami',
    state_or_province: 'FL',
    zip: '12346',
    country: 'US',
    mock: false
  })
};

fetch('https://api.wavix.com/v3/10dlc/brands/{brand_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v3/10dlc/brands/{brand_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'dba_name' => 'Brand',
    'company_name' => 'Company',
    'entity_type' => 'PRIVATE_PROFIT',
    'vertical' => 'HEALTHCARE',
    'ein_taxid' => '999999999',
    'ein_taxid_country' => 'US',
    'website' => 'https://brand.com',
    'stock_symbol' => '<string>',
    'stock_exchange' => '<string>',
    'first_name' => 'John',
    'last_name' => 'Dow',
    'phone_number' => '12123450099',
    'email' => 'support@brand.com',
    'street_address' => '10, City Name',
    'city' => 'Miami',
    'state_or_province' => 'FL',
    'zip' => '12346',
    'country' => 'US',
    'mock' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.wavix.com/v3/10dlc/brands/{brand_id}"

	payload := strings.NewReader("{\n  \"dba_name\": \"Brand\",\n  \"company_name\": \"Company\",\n  \"entity_type\": \"PRIVATE_PROFIT\",\n  \"vertical\": \"HEALTHCARE\",\n  \"ein_taxid\": \"999999999\",\n  \"ein_taxid_country\": \"US\",\n  \"website\": \"https://brand.com\",\n  \"stock_symbol\": \"<string>\",\n  \"stock_exchange\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Dow\",\n  \"phone_number\": \"12123450099\",\n  \"email\": \"support@brand.com\",\n  \"street_address\": \"10, City Name\",\n  \"city\": \"Miami\",\n  \"state_or_province\": \"FL\",\n  \"zip\": \"12346\",\n  \"country\": \"US\",\n  \"mock\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.wavix.com/v3/10dlc/brands/{brand_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dba_name\": \"Brand\",\n  \"company_name\": \"Company\",\n  \"entity_type\": \"PRIVATE_PROFIT\",\n  \"vertical\": \"HEALTHCARE\",\n  \"ein_taxid\": \"999999999\",\n  \"ein_taxid_country\": \"US\",\n  \"website\": \"https://brand.com\",\n  \"stock_symbol\": \"<string>\",\n  \"stock_exchange\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Dow\",\n  \"phone_number\": \"12123450099\",\n  \"email\": \"support@brand.com\",\n  \"street_address\": \"10, City Name\",\n  \"city\": \"Miami\",\n  \"state_or_province\": \"FL\",\n  \"zip\": \"12346\",\n  \"country\": \"US\",\n  \"mock\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v3/10dlc/brands/{brand_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dba_name\": \"Brand\",\n  \"company_name\": \"Company\",\n  \"entity_type\": \"PRIVATE_PROFIT\",\n  \"vertical\": \"HEALTHCARE\",\n  \"ein_taxid\": \"999999999\",\n  \"ein_taxid_country\": \"US\",\n  \"website\": \"https://brand.com\",\n  \"stock_symbol\": \"<string>\",\n  \"stock_exchange\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Dow\",\n  \"phone_number\": \"12123450099\",\n  \"email\": \"support@brand.com\",\n  \"street_address\": \"10, City Name\",\n  \"city\": \"Miami\",\n  \"state_or_province\": \"FL\",\n  \"zip\": \"12346\",\n  \"country\": \"US\",\n  \"mock\": false\n}"

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

{
  "brand_id": "BM20QP9",
  "city": "Miami",
  "company_name": "Company legal name",
  "country": "US",
  "created_at": "2024-07-24T08:10:49",
  "dba_name": "New Brand",
  "ein_taxid": "99999999",
  "ein_taxid_country": "US",
  "email": "support@brand.com",
  "entity_type": "PRIVATE_PROFIT",
  "feedback": null,
  "first_name": "John",
  "last_name": "Dow",
  "mock": false,
  "phone_number": "12123450099",
  "state_or_province": "FL",
  "status": "REVIEW",
  "stock_exchange": null,
  "stock_symbol": null,
  "street_address": "10, Street Name",
  "updated_at": "2024-07-24T09:02:19",
  "vertical": "HEALTHCARE",
  "website": "https://brand.com",
  "zip": "12345"
}

{
  "success": false,
  "message": "Missing or invalid parameter <param_name>"
}

{
  "success": false,
  "message": "Request failed. The feature is disabled for the account."
}

{
  "success": false,
  "message": "Request failed. The Brand is not found."
}

{
  "success": false,
  "message": "Invalid ein_taxid - ein_taxid is a nine-digit number. The format is XX-XXXXXXX. The \\\"-\\\" symbol is also accepted."
}

Authorizations

Authorization

string

header

required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Path Parameters

brand_id

string

required

The unique ID of the 10DLC Brand.

Example:

"BM20QP9"

Body

application/json

Fields to update on the 10DLC Brand. Only included fields are changed.

A request to update a 10DLC Brand details

dba_name

string

Brand name or DBA

Maximum string length: 255

Example:

"Brand"

company_name

string

Legal name of the company

Maximum string length: 255

Example:

"Company"

entity_type

enum<string>

Legal entity type of the company. One of PRIVATE_PROFIT (privately held for-profit company), PUBLIC_PROFIT (publicly traded for-profit company), NON_PROFIT (non-profit organization), or GOVERNMENT (government entity).

Available options:

PRIVATE_PROFIT,

PUBLIC_PROFIT,

NON_PROFIT,

GOVERNMENT

Example:

"PRIVATE_PROFIT"

vertical

enum<string>

Business segment the Brand operates in. One of:

HEALTHCARE — healthcare.
PROFESSIONAL — professional services.
RETAIL — retail.
TECHNOLOGY — technology.
EDUCATION — education.
FINANCIAL — financial services.
NON_PROFIT — non-profit organizations.
GOVERNMENT — government entities.
OTHER — any segment not listed above.

Available options:

HEALTHCARE,

PROFESSIONAL,

RETAIL,

TECHNOLOGY,

EDUCATION,

FINANCIAL,

NON_PROFIT,

GOVERNMENT,

OTHER

Example:

"HEALTHCARE"

ein_taxid

string

IRS Employee Identification Number (EIN) for US-based or foreign companies with EIN. The numeric portion of Tax ID for companies incorporated in other countries.

Maximum string length: 21

Example:

"999999999"

ein_taxid_country

string

2-letter ISO country code of the Tax ID issuing country

Required string length: 2

Example:

"US"

website

string

The website of the business

Maximum string length: 255

Example:

"https://brand.com"

stock_symbol

string | null

The stock symbol of the Brand. For PUBLIC_PROFIT Brands only.

Maximum string length: 10

stock_exchange

string | null

The stock exchange code. For PUBLIC_PROFIT Brands only.

Maximum string length: 10

first_name

string

The first name of the business contact

Maximum string length: 100

Example:

"John"

last_name

string

The last name of the business contact

Maximum string length: 100

Example:

"Dow"

phone_number

string

The support contact telephone in E.164 format

Maximum string length: 20

Example:

"12123450099"

string<email>

The email address of the support contact

Maximum string length: 100

Example:

"support@brand.com"

street_address

string

Street name and house number

Maximum string length: 100

Example:

"10, City Name"

city

string

The city name

Maximum string length: 100

Example:

"Miami"

state_or_province

string | null

State or province. For the United States, use 2 character codes.

Maximum string length: 20

Example:

"FL"

zip

string

The business zip or postal code

Maximum string length: 10

Example:

"12346"

country

string

2-letter ISO country code the business address

Required string length: 2

Example:

"US"

mock

boolean

default:false

Mock flag for testing (optional, defaults to false)

Example:

false

Response

Returns the updated 10DLC Brand.

Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns.

brand_id

string

required

Unique identifier of the Brand assigned by the registry.

Example:

"BM20QP9"

dba_name

string

required

Doing-business-as name, or the public-facing brand name.

Example:

"Brand"

company_name

string

required

Registered legal name of the company that owns the Brand.

Example:

"Company"

entity_type

enum<string>

required

Company entity type.

Available options:

PRIVATE_PROFIT,

PUBLIC_PROFIT,

NON_PROFIT,

GOVERNMENT

Example:

"PRIVATE_PROFIT"

vertical

string

required

Industry vertical the Brand operates in.

Example:

"HEALTHCARE"

ein_taxid

string

required

IRS Employer Identification Number (EIN) or other tax ID of the company.

Example:

"999999999"

ein_taxid_country

string

required

ISO 3166-1 alpha-2 country code where the Tax ID was issued.

Example:

"US"

status

enum<string>

required

Brand identity verification status.

Available options:

REVIEW,

VERIFIED,

UNVERIFIED,

VETTED_VERIFIED,

SUSPENDED

Example:

"VERIFIED"

first_name

string

required

Business contact first name.

Example:

"John"

last_name

string

required

Business contact last name.

Example:

"Dow"

phone_number

string

required

Support contact phone number in E.164 format.

Example:

"12123450099"

string

required

Support contact email address.

Example:

"support@brand.com"

street_address

string

required

Street address of the business.

Example:

"10, City Name"

city

string

required

City of the business address.

Example:

"Miami"

country

string

required

ISO 3166-1 alpha-2 country code of the business address.

Example:

"US"

zip

string

required

ZIP or postal code of the business address.

Example:

"12345"

feedback

string | null

required

Feedback from the identity verification process explaining the current status.

created_at

string

required

Timestamp when the Brand was created, in ISO 8601 format.

Example:

"2024-07-24T08:29:09"

updated_at

string

required

Timestamp when the Brand was last updated, in ISO 8601 format.

Example:

"2024-07-24T08:29:09"

website

string | null

Business website URL.

Example:

"https://brand.com"

stock_symbol

string | null

Stock ticker symbol of the company. Required for publicly traded companies.

stock_exchange

string | null

Code of the stock exchange the company is listed on. Required for publicly traded companies.

state_or_province

string | null

State or province of the business address.

Example:

"FL"

mock

boolean

default:false

Indicates whether the Brand is a mock brand for testing.

Example:

false

Retrieve a 10DLC Brand

Delete a 10DLC Brand

⌘I

Using the APIs

API reference

WebSocket protocol

Update a 10DLC Brand

Authorizations

Path Parameters

Body

Response