Skip to main content
WEBHOOK
/
webhooks
/
customers
/
upsert
{
  "customerId": "customer-12345",
  "personal_data": {
    "email": "[email protected]",
    "birthday": "1985-06-15",
    "firstName": "John",
    "lastName": "Doe",
    "name": "John Doe",
    "phone": "+14155551234",
    "streetAddress1": "123 Main Street",
    "streetAddress2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94102",
    "social_security_number_last_four": "1234",
    "country_code": "US",
    "timezone_name": "America/Los_Angeles",
    "preferred_language": "ENGLISH"
  },
  "autodialer_consent": true,
  "externalMetadata": {
    "home_phone": "+14155555555",
    "cell_phone": "+14155556666",
    "employer_name": "Acme Corporation",
    "employer_address": "456 Business Ave",
    "employer_city": "San Francisco",
    "employer_state": "CA",
    "employer_zip": "94103",
    "employer_department": "Sales",
    "employer_phone": "+14155557777",
    "employer_direct_line": "+14155558888",
    "pay_frequency": "biweekly",
    "pay_day": "Monday"
  }
}
{
  "status": "success",
  "customerId": "customer-12345",
  "created": "2025-10-31T18:30:00Z",
  "updated": "2025-10-31T18:30:00Z"
}

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
​
autodialer_consent
boolean

Whether the customer has consented to autodialer calls

Example:

true

​
externalMetadata
object

Additional metadata about the customer

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"