Customer Upsert Webhook

Authorizations

X-API-Key

string

header

required

Body

application/json

Customer data to upsert

customerId

string

required

Identifier for the customer in your system

Example:

"customer-12345"

personal_data

object

required

Show child attributes

personal_data.email

string<email>

required

Example:

"[email protected]"

personal_data.birthday

string<date>

required

Example:

"1985-06-15"

personal_data.firstName

string

Example:

"John"

personal_data.lastName

string

Example:

"Doe"

personal_data.name

string

Full name (alternative to first_name/last_name)

Example:

"John Doe"

personal_data.phone

string

Example:

"+14155551234"

personal_data.streetAddress1

string

Example:

"123 Main Street"

personal_data.streetAddress2

string

Example:

"Apt 4B"

personal_data.city

string

Example:

"San Francisco"

personal_data.state

string

Example:

"CA"

personal_data.zipCode

string

Example:

"94102"

Last 4 digits of SSN

Example:

"1234"

personal_data.country_code

string

Example:

"US"

personal_data.timezone_name

string

IANA timezone name (e.g., 'America/New_York', 'America/Los_Angeles')

Example:

"America/Los_Angeles"

personal_data.preferred_language

enum<string>

Available options:

ENGLISH,

SPANISH

Example:

"ENGLISH"

Whether the customer has consented to autodialer calls

Example:

true

externalMetadata

object

Additional metadata about the customer

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:

"Monday"

Response

Customer upserted successfully

status

string

Example:

"success"

customerId

string

Example:

"customer-12345"

created

string<date-time>

Example:

"2025-10-31T18:30:00Z"

updated

string<date-time>

Example:

"2025-10-31T18:30:00Z"

API Documentation

Endpoint Examples

Customer Upsert Webhook

Authorizations

Body

Response