Update Registration

curl --request PATCH \
  --url https://api.example.com/v2/cnam-registration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "legal_business_name": "<string>",
  "street_address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "business_type": "<string>",
  "business_industry": "<string>",
  "registration_id_type": "<string>",
  "registration_number": "<string>",
  "regions_of_operation": [
    "<string>"
  ],
  "website": "<string>",
  "contact_first_name": "<string>",
  "contact_last_name": "<string>",
  "contact_email": "<string>",
  "contact_phone": "<string>",
  "contact_title": "<string>"
}
'

import requests

url = "https://api.example.com/v2/cnam-registration"

payload = {
    "display_name": "<string>",
    "legal_business_name": "<string>",
    "street_address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>",
    "business_type": "<string>",
    "business_industry": "<string>",
    "registration_id_type": "<string>",
    "registration_number": "<string>",
    "regions_of_operation": ["<string>"],
    "website": "<string>",
    "contact_first_name": "<string>",
    "contact_last_name": "<string>",
    "contact_email": "<string>",
    "contact_phone": "<string>",
    "contact_title": "<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({
    display_name: '<string>',
    legal_business_name: '<string>',
    street_address: '<string>',
    city: '<string>',
    state: '<string>',
    postal_code: '<string>',
    country: '<string>',
    business_type: '<string>',
    business_industry: '<string>',
    registration_id_type: '<string>',
    registration_number: '<string>',
    regions_of_operation: ['<string>'],
    website: '<string>',
    contact_first_name: '<string>',
    contact_last_name: '<string>',
    contact_email: '<string>',
    contact_phone: '<string>',
    contact_title: '<string>'
  })
};

fetch('https://api.example.com/v2/cnam-registration', 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.example.com/v2/cnam-registration",
  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([
    'display_name' => '<string>',
    'legal_business_name' => '<string>',
    'street_address' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'postal_code' => '<string>',
    'country' => '<string>',
    'business_type' => '<string>',
    'business_industry' => '<string>',
    'registration_id_type' => '<string>',
    'registration_number' => '<string>',
    'regions_of_operation' => [
        '<string>'
    ],
    'website' => '<string>',
    'contact_first_name' => '<string>',
    'contact_last_name' => '<string>',
    'contact_email' => '<string>',
    'contact_phone' => '<string>',
    'contact_title' => '<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.example.com/v2/cnam-registration"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"legal_business_name\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"<string>\",\n  \"business_type\": \"<string>\",\n  \"business_industry\": \"<string>\",\n  \"registration_id_type\": \"<string>\",\n  \"registration_number\": \"<string>\",\n  \"regions_of_operation\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"contact_first_name\": \"<string>\",\n  \"contact_last_name\": \"<string>\",\n  \"contact_email\": \"<string>\",\n  \"contact_phone\": \"<string>\",\n  \"contact_title\": \"<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.example.com/v2/cnam-registration")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"legal_business_name\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"<string>\",\n  \"business_type\": \"<string>\",\n  \"business_industry\": \"<string>\",\n  \"registration_id_type\": \"<string>\",\n  \"registration_number\": \"<string>\",\n  \"regions_of_operation\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"contact_first_name\": \"<string>\",\n  \"contact_last_name\": \"<string>\",\n  \"contact_email\": \"<string>\",\n  \"contact_phone\": \"<string>\",\n  \"contact_title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/cnam-registration")

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  \"display_name\": \"<string>\",\n  \"legal_business_name\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"<string>\",\n  \"business_type\": \"<string>\",\n  \"business_industry\": \"<string>\",\n  \"registration_id_type\": \"<string>\",\n  \"registration_number\": \"<string>\",\n  \"regions_of_operation\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"contact_first_name\": \"<string>\",\n  \"contact_last_name\": \"<string>\",\n  \"contact_email\": \"<string>\",\n  \"contact_phone\": \"<string>\",\n  \"contact_title\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": "<string>",
  "status_detail": "<string>",
  "display_name": "<string>",
  "legal_business_name": "<string>",
  "street_address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "business_type": "<string>",
  "business_industry": "<string>",
  "registration_id_type": "<string>",
  "registration_number": "<string>",
  "regions_of_operation": [
    "<string>"
  ],
  "website": "<string>",
  "contact_first_name": "<string>",
  "contact_last_name": "<string>",
  "contact_email": "<string>",
  "contact_phone": "<string>",
  "contact_title": "<string>",
  "phone_number": "<string>",
  "user_id": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "approved_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "object": "<string>"
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "detail": "<string>"
}

PATCH

cnam-registration

Update Registration

curl --request PATCH \
  --url https://api.example.com/v2/cnam-registration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "legal_business_name": "<string>",
  "street_address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "business_type": "<string>",
  "business_industry": "<string>",
  "registration_id_type": "<string>",
  "registration_number": "<string>",
  "regions_of_operation": [
    "<string>"
  ],
  "website": "<string>",
  "contact_first_name": "<string>",
  "contact_last_name": "<string>",
  "contact_email": "<string>",
  "contact_phone": "<string>",
  "contact_title": "<string>"
}
'

import requests

url = "https://api.example.com/v2/cnam-registration"

payload = {
    "display_name": "<string>",
    "legal_business_name": "<string>",
    "street_address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>",
    "business_type": "<string>",
    "business_industry": "<string>",
    "registration_id_type": "<string>",
    "registration_number": "<string>",
    "regions_of_operation": ["<string>"],
    "website": "<string>",
    "contact_first_name": "<string>",
    "contact_last_name": "<string>",
    "contact_email": "<string>",
    "contact_phone": "<string>",
    "contact_title": "<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({
    display_name: '<string>',
    legal_business_name: '<string>',
    street_address: '<string>',
    city: '<string>',
    state: '<string>',
    postal_code: '<string>',
    country: '<string>',
    business_type: '<string>',
    business_industry: '<string>',
    registration_id_type: '<string>',
    registration_number: '<string>',
    regions_of_operation: ['<string>'],
    website: '<string>',
    contact_first_name: '<string>',
    contact_last_name: '<string>',
    contact_email: '<string>',
    contact_phone: '<string>',
    contact_title: '<string>'
  })
};

fetch('https://api.example.com/v2/cnam-registration', 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.example.com/v2/cnam-registration",
  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([
    'display_name' => '<string>',
    'legal_business_name' => '<string>',
    'street_address' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'postal_code' => '<string>',
    'country' => '<string>',
    'business_type' => '<string>',
    'business_industry' => '<string>',
    'registration_id_type' => '<string>',
    'registration_number' => '<string>',
    'regions_of_operation' => [
        '<string>'
    ],
    'website' => '<string>',
    'contact_first_name' => '<string>',
    'contact_last_name' => '<string>',
    'contact_email' => '<string>',
    'contact_phone' => '<string>',
    'contact_title' => '<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.example.com/v2/cnam-registration"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"legal_business_name\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"<string>\",\n  \"business_type\": \"<string>\",\n  \"business_industry\": \"<string>\",\n  \"registration_id_type\": \"<string>\",\n  \"registration_number\": \"<string>\",\n  \"regions_of_operation\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"contact_first_name\": \"<string>\",\n  \"contact_last_name\": \"<string>\",\n  \"contact_email\": \"<string>\",\n  \"contact_phone\": \"<string>\",\n  \"contact_title\": \"<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.example.com/v2/cnam-registration")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"legal_business_name\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"<string>\",\n  \"business_type\": \"<string>\",\n  \"business_industry\": \"<string>\",\n  \"registration_id_type\": \"<string>\",\n  \"registration_number\": \"<string>\",\n  \"regions_of_operation\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"contact_first_name\": \"<string>\",\n  \"contact_last_name\": \"<string>\",\n  \"contact_email\": \"<string>\",\n  \"contact_phone\": \"<string>\",\n  \"contact_title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/cnam-registration")

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  \"display_name\": \"<string>\",\n  \"legal_business_name\": \"<string>\",\n  \"street_address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"<string>\",\n  \"business_type\": \"<string>\",\n  \"business_industry\": \"<string>\",\n  \"registration_id_type\": \"<string>\",\n  \"registration_number\": \"<string>\",\n  \"regions_of_operation\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"contact_first_name\": \"<string>\",\n  \"contact_last_name\": \"<string>\",\n  \"contact_email\": \"<string>\",\n  \"contact_phone\": \"<string>\",\n  \"contact_title\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": "<string>",
  "status_detail": "<string>",
  "display_name": "<string>",
  "legal_business_name": "<string>",
  "street_address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "business_type": "<string>",
  "business_industry": "<string>",
  "registration_id_type": "<string>",
  "registration_number": "<string>",
  "regions_of_operation": [
    "<string>"
  ],
  "website": "<string>",
  "contact_first_name": "<string>",
  "contact_last_name": "<string>",
  "contact_email": "<string>",
  "contact_phone": "<string>",
  "contact_title": "<string>",
  "phone_number": "<string>",
  "user_id": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "approved_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "object": "<string>"
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for updating a failed/rejected CNAM registration.

display_name

string | null

Maximum string length: 15

legal_business_name

string | null

street_address

string | null

city

string | null

state

string | null

postal_code

string | null

country

string | null

business_type

string | null

business_industry

string | null

registration_id_type

string | null

registration_number

string | null

regions_of_operation

string[] | null

website

string | null

contact_first_name

string | null

contact_last_name

string | null

contact_email

string | null

contact_phone

string | null

contact_title

string | null

Response

Successful Response

created_at

string<date-time>

required

modified_at

string<date-time> | null

required

string

required

status

string

required

Current registration status

status_detail

string | null

required

Human-readable status message or rejection reason

display_name

string

required

Caller ID display name (max 15 characters)

legal_business_name

string

required

Legal business name

street_address

string

required

Business street address

city

string

required

Business city

state

string

required

Business state/province

postal_code

string

required

Business postal code

country

string

required

Business country

business_type

string

required

Business type, e.g. LLC, Corporation

business_industry

string

required

Business industry, e.g. Technology

registration_id_type

string

required

Registration ID type, e.g. EIN

registration_number

string

required

Business registration number, e.g. EIN number

regions_of_operation

string[]

required

Regions of operation, e.g. United States, Canada

website

string | null

required

Business website URL

contact_first_name

string

required

Contact first name

contact_last_name

string

required

Contact last name

contact_email

string

required

Contact email

contact_phone

string

required

Contact phone number

contact_title

string

required

Contact job title

phone_number

string | null

required

Phone number registered for CNAM (e164 format)

user_id

string | null

required

User who submitted the registration (null for backfilled records)

submitted_at

string<date-time> | null

required

When the registration was submitted for processing

approved_at

string<date-time> | null

required

When Twilio approved the registration

error_message

string | null

required

Error details if registration failed

object

string

required

read-only

String representing the object's type. Objects of the same type share the same value.

Delete Registration Get Credit Memo Search

⌘I