Update Customer

cURL

curl --request PUT \
  --url https://api.example.com/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "birthday": "2023-12-25",
  "timezone": "<string>",
  "phoneNumber": "<string>",
  "ssnLastFour": "<string>",
  "doNotCall": true,
  "state": "CA"
}
'

import requests

url = "https://api.example.com/customers/{id}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "[email protected]",
    "birthday": "2023-12-25",
    "timezone": "<string>",
    "phoneNumber": "<string>",
    "ssnLastFour": "<string>",
    "doNotCall": True,
    "state": "CA"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '[email protected]',
    birthday: '2023-12-25',
    timezone: '<string>',
    phoneNumber: '<string>',
    ssnLastFour: '<string>',
    doNotCall: true,
    state: 'CA'
  })
};

fetch('https://api.example.com/customers/{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.example.com/customers/{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([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '[email protected]',
    'birthday' => '2023-12-25',
    'timezone' => '<string>',
    'phoneNumber' => '<string>',
    'ssnLastFour' => '<string>',
    'doNotCall' => true,
    'state' => 'CA'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/customers/{id}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"2023-12-25\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"ssnLastFour\": \"<string>\",\n  \"doNotCall\": true,\n  \"state\": \"CA\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.example.com/customers/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"2023-12-25\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"ssnLastFour\": \"<string>\",\n  \"doNotCall\": true,\n  \"state\": \"CA\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers/{id}")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"2023-12-25\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"ssnLastFour\": \"<string>\",\n  \"doNotCall\": true,\n  \"state\": \"CA\"\n}"

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

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "birthday": "2023-12-25",
  "ssnLastFour": "<string>",
  "timezone": "<string>",
  "phoneNumber": "<string>",
  "streetAddress1": "<string>",
  "streetAddress2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "doNotCall": true,
  "isTest": true,
  "taskType": "<string>",
  "externalMetadata": {}
}

{
  "error": 123,
  "message": "<string>"
}

PUT

customers

{id}

cURL

curl --request PUT \
  --url https://api.example.com/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "birthday": "2023-12-25",
  "timezone": "<string>",
  "phoneNumber": "<string>",
  "ssnLastFour": "<string>",
  "doNotCall": true,
  "state": "CA"
}
'

import requests

url = "https://api.example.com/customers/{id}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "[email protected]",
    "birthday": "2023-12-25",
    "timezone": "<string>",
    "phoneNumber": "<string>",
    "ssnLastFour": "<string>",
    "doNotCall": True,
    "state": "CA"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '[email protected]',
    birthday: '2023-12-25',
    timezone: '<string>',
    phoneNumber: '<string>',
    ssnLastFour: '<string>',
    doNotCall: true,
    state: 'CA'
  })
};

fetch('https://api.example.com/customers/{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.example.com/customers/{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([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '[email protected]',
    'birthday' => '2023-12-25',
    'timezone' => '<string>',
    'phoneNumber' => '<string>',
    'ssnLastFour' => '<string>',
    'doNotCall' => true,
    'state' => 'CA'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/customers/{id}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"2023-12-25\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"ssnLastFour\": \"<string>\",\n  \"doNotCall\": true,\n  \"state\": \"CA\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.example.com/customers/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"2023-12-25\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"ssnLastFour\": \"<string>\",\n  \"doNotCall\": true,\n  \"state\": \"CA\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers/{id}")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"2023-12-25\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"ssnLastFour\": \"<string>\",\n  \"doNotCall\": true,\n  \"state\": \"CA\"\n}"

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

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "birthday": "2023-12-25",
  "ssnLastFour": "<string>",
  "timezone": "<string>",
  "phoneNumber": "<string>",
  "streetAddress1": "<string>",
  "streetAddress2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "doNotCall": true,
  "isTest": true,
  "taskType": "<string>",
  "externalMetadata": {}
}

{
  "error": 123,
  "message": "<string>"
}

Name Fields

You can update the customer’s name by providing either or both fields:

firstName - Update customer’s first name
lastName - Update customer’s last name

Both fields are optional, allowing you to update them independently. The API response will return both fields separately as they are stored in the database.

Authorizations

X-API-Key

string

header

required

Path Parameters

string

required

ID of customer to update

Body

application/json

Customer to update

Partial update. Every field is optional — only the fields you send are modified; omitted fields keep their existing values.

firstName

string

First name of the customer

lastName

string

Last name of the customer

string<email>

Customer email address

birthday

string<date>

Customer birthday in YYYY-MM-DD format

timezone

string

Timezone of the customer

phoneNumber

string

Phone number of the customer

ssnLastFour

string

Last 4 digits of SSN

doNotCall

boolean

Do not call the customer

state

string

State code

Example:

"CA"

Response

Customer response

string

required

Unique identifier for the customer. This is your customer reference and should match your internal system's ID.

firstName

string

required

The first name of the customer

lastName

string

required

The last name of the customer

string<email>

Customer email address

birthday

string<date>

Customer birthday in YYYY-MM-DD format

ssnLastFour

string

Last 4 digits of SSN

timezone

string

Timezone of the customer (IANA timezone name, e.g., 'America/New_York', 'America/Los_Angeles')

phoneNumber

string

Phone number of the customer

streetAddress1

string

Street address line 1

streetAddress2

string

Street address line 2 (optional)

city

string

City name

state

string

State code (e.g., NY, CA)

zipCode

string

ZIP/postal code

doNotCall

boolean

Do not call the customer

isTest

boolean

Indicates if this is a test customer

taskType

string

Type of tasks created for the customer's automated call schedule

externalMetadata

object

Additional custom metadata about the customer

Get Customer Create Customer

API Documentation

Endpoint Examples

Update Customer

Name Fields

Authorizations

Path Parameters

Body

Response

​Name Fields

Authorizations

Path Parameters

Body

Response

Name Fields