Update Customer

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

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>

required

Customer email address

Example:

"[email protected]"

birthday

string<date>

required

Customer birthday in YYYY-MM-DD format

Example:

"1985-06-15"

streetAddress1

string

required

Street address line 1 (required)

Example:

"123 Main St"

city

string

required

City (required)

Example:

"San Francisco"

state

string

required

State code (required)

Example:

"CA"

zipCode

string

required

ZIP/postal code (required)

Example:

"94102"

taskType

string

required

Type of tasks to create for the customer's automated call schedule. Valid values depend on company configuration. This field is required.

Example:

"collections"

ssnLastFour

string

Last 4 digits of SSN

Example:

"1234"

timezone

string

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

phoneNumber

string

Phone number of the customer

streetAddress2

string

Street address line 2 (optional)

Example:

"Apt 4B"

doNotCall

boolean

Do not call the customer

isTest

boolean

Indicates if this is a test customer

test

boolean

default:false

Mark customer as test customer

externalMetadata

object

Additional custom metadata about the customer (e.g. employer information, pay schedule, additional contact details)

Show child attributes

externalMetadata.home_phone

string

Example:

"+14155555555"

externalMetadata.cell_phone

string

Example:

"+14155556666"

externalMetadata.employer_name

string

Example:

"Acme Corporation"

externalMetadata.employer_address

string

Example:

"456 Business Ave"

externalMetadata.employer_city

string

Example:

"San Francisco"

externalMetadata.employer_state

string

Example:

"CA"

externalMetadata.employer_zip

string

Example:

"94103"

externalMetadata.employer_department

string

Example:

"Sales"

externalMetadata.employer_phone

string

Example:

"+14155557777"

externalMetadata.employer_direct_line

string

Example:

"+14155558888"

externalMetadata.pay_frequency

string

Example:

"biweekly"

externalMetadata.pay_day

string

Example:

"Friday"

Response

Customer response

firstName

string

required

The first name of the customer

lastName

string

required

The last name of the customer

string

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

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

API Documentation

Endpoint Examples

Update Customer

Name Fields

Authorizations

Path Parameters

Body

Response

API Documentation

Endpoint Examples

​Name Fields

Authorizations

Path Parameters

Body

Response

Name Fields