10DLC
Update 10DLC brand
Update a 10DLC brand in draft status. Cannot update after submission.
PATCH
/
v1
/
10dlc
/
brands
/
{brandId}
Update 10DLC brand
curl --request PATCH \
--url https://api.zavu.dev/v1/10dlc/brands/{brandId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"companyName": "<string>",
"ein": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"website": "<string>",
"vertical": "<string>",
"stockSymbol": "<string>",
"stockExchange": "<string>"
}
'import requests
url = "https://api.zavu.dev/v1/10dlc/brands/{brandId}"
payload = {
"displayName": "<string>",
"companyName": "<string>",
"ein": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"website": "<string>",
"vertical": "<string>",
"stockSymbol": "<string>",
"stockExchange": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
companyName: '<string>',
ein: '<string>',
firstName: '<string>',
lastName: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
website: '<string>',
vertical: '<string>',
stockSymbol: '<string>',
stockExchange: '<string>'
})
};
fetch('https://api.zavu.dev/v1/10dlc/brands/{brandId}', 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.zavu.dev/v1/10dlc/brands/{brandId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => '<string>',
'companyName' => '<string>',
'ein' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'website' => '<string>',
'vertical' => '<string>',
'stockSymbol' => '<string>',
'stockExchange' => '<string>'
]),
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.zavu.dev/v1/10dlc/brands/{brandId}"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"ein\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"stockSymbol\": \"<string>\",\n \"stockExchange\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zavu.dev/v1/10dlc/brands/{brandId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"ein\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"stockSymbol\": \"<string>\",\n \"stockExchange\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/10dlc/brands/{brandId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"ein\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"stockSymbol\": \"<string>\",\n \"stockExchange\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"brand": {
"id": "<string>",
"displayName": "Acme Corp",
"email": "jsmith@example.com",
"phone": "+14155551234",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "US",
"vertical": "Technology",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"companyName": "<string>",
"ein": "12-3456789",
"firstName": "<string>",
"lastName": "<string>",
"website": "<string>",
"stockSymbol": "<string>",
"stockExchange": "<string>",
"brandScore": 123,
"brandRelationship": "<string>",
"failureReason": "<string>",
"submittedAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
10DLC brand ID.
Body
application/json
Business entity type for 10DLC brand registration.
Available options:
PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT, SOLE_PROPRIETOR Maximum string length:
100Maximum string length:
200Maximum string length:
50Maximum string length:
50Maximum string length:
200Maximum string length:
100Maximum string length:
50Maximum string length:
20Required string length:
2Maximum string length:
50Maximum string length:
10Maximum string length:
50Response
Brand updated.
Show child attributes
Show child attributes
⌘I
Update 10DLC brand
curl --request PATCH \
--url https://api.zavu.dev/v1/10dlc/brands/{brandId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"companyName": "<string>",
"ein": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"website": "<string>",
"vertical": "<string>",
"stockSymbol": "<string>",
"stockExchange": "<string>"
}
'import requests
url = "https://api.zavu.dev/v1/10dlc/brands/{brandId}"
payload = {
"displayName": "<string>",
"companyName": "<string>",
"ein": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"website": "<string>",
"vertical": "<string>",
"stockSymbol": "<string>",
"stockExchange": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
companyName: '<string>',
ein: '<string>',
firstName: '<string>',
lastName: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
website: '<string>',
vertical: '<string>',
stockSymbol: '<string>',
stockExchange: '<string>'
})
};
fetch('https://api.zavu.dev/v1/10dlc/brands/{brandId}', 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.zavu.dev/v1/10dlc/brands/{brandId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => '<string>',
'companyName' => '<string>',
'ein' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'website' => '<string>',
'vertical' => '<string>',
'stockSymbol' => '<string>',
'stockExchange' => '<string>'
]),
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.zavu.dev/v1/10dlc/brands/{brandId}"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"ein\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"stockSymbol\": \"<string>\",\n \"stockExchange\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zavu.dev/v1/10dlc/brands/{brandId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"ein\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"stockSymbol\": \"<string>\",\n \"stockExchange\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/10dlc/brands/{brandId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"ein\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"website\": \"<string>\",\n \"vertical\": \"<string>\",\n \"stockSymbol\": \"<string>\",\n \"stockExchange\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"brand": {
"id": "<string>",
"displayName": "Acme Corp",
"email": "jsmith@example.com",
"phone": "+14155551234",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "US",
"vertical": "Technology",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"companyName": "<string>",
"ein": "12-3456789",
"firstName": "<string>",
"lastName": "<string>",
"website": "<string>",
"stockSymbol": "<string>",
"stockExchange": "<string>",
"brandScore": 123,
"brandRelationship": "<string>",
"failureReason": "<string>",
"submittedAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}