Customer Schedule Sync

cURL

curl --request POST \
  --url https://api.example.com/customers/schedule/sync \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "timezone": "<string>",
  "phoneNumber": "<string>",
  "taskType": "collections",
  "email": "[email protected]",
  "birthday": "1985-06-15",
  "ssnLastFour": "1234",
  "streetAddress1": "123 Main St",
  "streetAddress2": "Apt 4B",
  "city": "San Francisco",
  "state": "CA",
  "zipCode": "94102",
  "doNotCall": true,
  "test": false,
  "externalMetadata": {},
  "sync": false,
  "loanId": "<string>"
}
'

import requests

url = "https://api.example.com/customers/schedule/sync"

payload = {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "timezone": "<string>",
    "phoneNumber": "<string>",
    "taskType": "collections",
    "email": "[email protected]",
    "birthday": "1985-06-15",
    "ssnLastFour": "1234",
    "streetAddress1": "123 Main St",
    "streetAddress2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94102",
    "doNotCall": True,
    "test": False,
    "externalMetadata": {},
    "sync": False,
    "loanId": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    timezone: '<string>',
    phoneNumber: '<string>',
    taskType: 'collections',
    email: '[email protected]',
    birthday: '1985-06-15',
    ssnLastFour: '1234',
    streetAddress1: '123 Main St',
    streetAddress2: 'Apt 4B',
    city: 'San Francisco',
    state: 'CA',
    zipCode: '94102',
    doNotCall: true,
    test: false,
    externalMetadata: {},
    sync: false,
    loanId: '<string>'
  })
};

fetch('https://api.example.com/customers/schedule/sync', 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/schedule/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'timezone' => '<string>',
    'phoneNumber' => '<string>',
    'taskType' => 'collections',
    'email' => '[email protected]',
    'birthday' => '1985-06-15',
    'ssnLastFour' => '1234',
    'streetAddress1' => '123 Main St',
    'streetAddress2' => 'Apt 4B',
    'city' => 'San Francisco',
    'state' => 'CA',
    'zipCode' => '94102',
    'doNotCall' => true,
    'test' => false,
    'externalMetadata' => [
        
    ],
    'sync' => false,
    'loanId' => '<string>'
  ]),
  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/schedule/sync"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"taskType\": \"collections\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"1985-06-15\",\n  \"ssnLastFour\": \"1234\",\n  \"streetAddress1\": \"123 Main St\",\n  \"streetAddress2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"zipCode\": \"94102\",\n  \"doNotCall\": true,\n  \"test\": false,\n  \"externalMetadata\": {},\n  \"sync\": false,\n  \"loanId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/customers/schedule/sync")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"taskType\": \"collections\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"1985-06-15\",\n  \"ssnLastFour\": \"1234\",\n  \"streetAddress1\": \"123 Main St\",\n  \"streetAddress2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"zipCode\": \"94102\",\n  \"doNotCall\": true,\n  \"test\": false,\n  \"externalMetadata\": {},\n  \"sync\": false,\n  \"loanId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers/schedule/sync")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"taskType\": \"collections\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"1985-06-15\",\n  \"ssnLastFour\": \"1234\",\n  \"streetAddress1\": \"123 Main St\",\n  \"streetAddress2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"zipCode\": \"94102\",\n  \"doNotCall\": true,\n  \"test\": false,\n  \"externalMetadata\": {},\n  \"sync\": false,\n  \"loanId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "scheduleCreated": true,
  "tasksCreated": 1,
  "existingTasksRemoved": 3,
  "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>"
}

POST

customers

schedule

sync

cURL

curl --request POST \
  --url https://api.example.com/customers/schedule/sync \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "timezone": "<string>",
  "phoneNumber": "<string>",
  "taskType": "collections",
  "email": "[email protected]",
  "birthday": "1985-06-15",
  "ssnLastFour": "1234",
  "streetAddress1": "123 Main St",
  "streetAddress2": "Apt 4B",
  "city": "San Francisco",
  "state": "CA",
  "zipCode": "94102",
  "doNotCall": true,
  "test": false,
  "externalMetadata": {},
  "sync": false,
  "loanId": "<string>"
}
'

import requests

url = "https://api.example.com/customers/schedule/sync"

payload = {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "timezone": "<string>",
    "phoneNumber": "<string>",
    "taskType": "collections",
    "email": "[email protected]",
    "birthday": "1985-06-15",
    "ssnLastFour": "1234",
    "streetAddress1": "123 Main St",
    "streetAddress2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94102",
    "doNotCall": True,
    "test": False,
    "externalMetadata": {},
    "sync": False,
    "loanId": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    timezone: '<string>',
    phoneNumber: '<string>',
    taskType: 'collections',
    email: '[email protected]',
    birthday: '1985-06-15',
    ssnLastFour: '1234',
    streetAddress1: '123 Main St',
    streetAddress2: 'Apt 4B',
    city: 'San Francisco',
    state: 'CA',
    zipCode: '94102',
    doNotCall: true,
    test: false,
    externalMetadata: {},
    sync: false,
    loanId: '<string>'
  })
};

fetch('https://api.example.com/customers/schedule/sync', 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/schedule/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'timezone' => '<string>',
    'phoneNumber' => '<string>',
    'taskType' => 'collections',
    'email' => '[email protected]',
    'birthday' => '1985-06-15',
    'ssnLastFour' => '1234',
    'streetAddress1' => '123 Main St',
    'streetAddress2' => 'Apt 4B',
    'city' => 'San Francisco',
    'state' => 'CA',
    'zipCode' => '94102',
    'doNotCall' => true,
    'test' => false,
    'externalMetadata' => [
        
    ],
    'sync' => false,
    'loanId' => '<string>'
  ]),
  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/schedule/sync"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"taskType\": \"collections\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"1985-06-15\",\n  \"ssnLastFour\": \"1234\",\n  \"streetAddress1\": \"123 Main St\",\n  \"streetAddress2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"zipCode\": \"94102\",\n  \"doNotCall\": true,\n  \"test\": false,\n  \"externalMetadata\": {},\n  \"sync\": false,\n  \"loanId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/customers/schedule/sync")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"taskType\": \"collections\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"1985-06-15\",\n  \"ssnLastFour\": \"1234\",\n  \"streetAddress1\": \"123 Main St\",\n  \"streetAddress2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"zipCode\": \"94102\",\n  \"doNotCall\": true,\n  \"test\": false,\n  \"externalMetadata\": {},\n  \"sync\": false,\n  \"loanId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers/schedule/sync")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"taskType\": \"collections\",\n  \"email\": \"[email protected]\",\n  \"birthday\": \"1985-06-15\",\n  \"ssnLastFour\": \"1234\",\n  \"streetAddress1\": \"123 Main St\",\n  \"streetAddress2\": \"Apt 4B\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"zipCode\": \"94102\",\n  \"doNotCall\": true,\n  \"test\": false,\n  \"externalMetadata\": {},\n  \"sync\": false,\n  \"loanId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "scheduleCreated": true,
  "tasksCreated": 1,
  "existingTasksRemoved": 3,
  "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>"
}

Overview

This endpoint provides an idempotent way to sync a customer’s call schedule. It will:

Create or update the customer with the provided data
Remove all pending tasks for the customer
Create a new call schedule based on the task type

Calling this endpoint multiple times with the same data will produce the same result, making it safe for retries and integration workflows.

Authentication

Authentication via X-API-Key header. See Authentication for details.

Request Body

The request accepts largely the same fields as the Create Customer endpoint, with the same validations. It does not accept loanIds. This endpoint is not affected by the upcoming Create Customer contract changes — its required fields and its test and loanId parameters are unchanged.

Always Required

id - External customer reference ID (required)
firstName - Customer’s first name (required)
lastName - Customer’s last name (required)
phoneNumber - Customer’s phone number (required) - Used for automated calling and SMS communications
timezone - Customer’s timezone as an IANA timezone name (e.g., “America/New_York”, “America/Los_Angeles”, “America/Chicago”) (required) - Required for TCPA compliance to ensure calls are made during appropriate hours. Must be a valid IANA timezone identifier.
taskType - Task type for customer’s call schedule (required)

Required unless `sync: true`

email - Customer email address (required)
streetAddress1 - Street address line 1 (required)
city - City name (required)
state - State code (e.g., “NY”, “CA”) (required)
zipCode - ZIP/postal code (required)

Optional Fields

birthday - Customer birthday (YYYY-MM-DD format)
ssnLastFour - Last 4 digits of SSN
doNotCall - Whether to mark customer for Do Not Call (optional; if not provided, existing value is preserved)
test - Mark customer as test customer (default: false)
externalMetadata - Custom JSON object with additional customer data
streetAddress2 - Street address line 2
loanId - LMS loan ID, stored on the created tasks so call outcomes can be written back against the right loan
sync - When true, auto-fetch missing customer data from your company’s LMS (default: false). See the Create Customer endpoint for details.

Response Body

The API returns all customer fields that were provided in the request body, along with any computed fields and sync operation metadata. This includes:

Basic Information: id, firstName, lastName, email, phoneNumber, timezone
Personal Information: birthday, ssnLastFour
Address Information: streetAddress1, streetAddress2, city, state, zipCode
Configuration: taskType, doNotCall, isTest
Custom Data: externalMetadata - The complete metadata object you provided
Sync Metadata: schedule_created, tasks_created, existing_tasks_removed - Information about the sync operation performed

All fields that were included in the request will be returned in the response, along with sync metadata that indicates what actions were taken during the sync operation.

Sync Metadata Fields

In addition to all the customer fields, the response includes three metadata fields that describe the sync operation:

schedule_created (boolean): Whether a new schedule was created during this sync operation. This will be true if the customer has both a valid timezone and phone number, and false if either is missing.
tasks_created (integer): The number of new tasks created as part of the schedule.
existing_tasks_removed (integer): The number of pending tasks that were removed before creating the new schedule. This ensures a clean slate for the new schedule and prevents duplicate tasks.

Schedule Creation

The response will indicate whether the schedule was successfully created via the schedule_created field.

Do Not Call Validation

If an existing customer is already marked as Do Not Call, the endpoint will return a 400 error unless you explicitly set doNotCall: false in the request. Behavior:

If doNotCall is not provided (omitted from request) and the customer has Do Not Call status → Error (prevents accidental schedule creation)
If doNotCall: true and the customer has Do Not Call status → Error (attempting to maintain Do Not Call while creating schedule)
If doNotCall: false and the customer has Do Not Call status → Success (explicitly removing Do Not Call and creating schedule)
If doNotCall is not provided and the customer does NOT have Do Not Call status → Success (preserves existing state)

Idempotency

This endpoint is designed to be idempotent:

If a customer with the given id exists, it will be updated
All pending tasks are removed before creating the new schedule
Calling the endpoint multiple times with the same data produces the same result
Safe for retries in case of network failures or integration workflows

Use Cases

This endpoint is useful for:

Re-syncing customer data from external systems
Resetting call schedules after customer information changes
Bulk customer updates where you want to ensure consistent state
Integration workflows that need guaranteed idempotency

Authorizations

X-API-Key

string

header

required

Body

application/json

Customer data to sync

Customer data for the schedule sync endpoint. This endpoint is NOT affected by the upcoming Create Customer contract change.

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

timezone

string

required

Timezone of the customer (IANA timezone name, e.g., 'America/New_York', 'America/Los_Angeles'). Required for TCPA compliance so calls are placed during permitted hours.

phoneNumber

string

required

Phone number of the customer

taskType

string

required

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

Example:

"collections"

string<email>

Customer email address. Required unless sync is true.

Example:

"[email protected]"

birthday

string<date>

Customer birthday in YYYY-MM-DD format

Example:

"1985-06-15"

ssnLastFour

string

Last 4 digits of SSN

Example:

"1234"

streetAddress1

string

Street address line 1. Required unless sync is true.

Example:

"123 Main St"

streetAddress2

string

Street address line 2 (optional)

Example:

"Apt 4B"

city

string

City. Required unless sync is true.

Example:

"San Francisco"

state

string

State code. Required unless sync is true.

Example:

"CA"

zipCode

string

ZIP/postal code. Required unless sync is true.

Example:

"94102"

doNotCall

boolean

Do not call the customer. If omitted, the existing value is preserved.

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)

sync

boolean

default:false

When true, auto-fetch missing customer data from your integrated lending system. Defaults to false.

loanId

string

Loan reference ID from your lending system, stored on the created tasks so call outcomes can be written back against the right loan.

Response

Customer schedule synced successfully

string

required

Customer ID (reference_id)

firstName

string

required

Customer's first name

lastName

string

required

Customer's last name

scheduleCreated

boolean

required

Whether a new schedule was created during this sync operation

Example:

true

tasksCreated

integer

required

Number of new tasks created as part of the schedule

Example:

1

existingTasksRemoved

integer

required

Number of pending tasks that were removed before creating the new schedule

Example:

3

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

Delete Customer Cancel Communications

API Documentation

Endpoint Examples

Customer Schedule Sync

Overview

Authentication

Request Body

Always Required

Required unless `sync: true`

Optional Fields

Response Body

Sync Metadata Fields

Schedule Creation

Do Not Call Validation

Idempotency

Use Cases

Authorizations

Body

Response

​Overview

​Authentication

​Request Body

​Always Required

​Required unless sync: true

​Optional Fields

​Response Body

​Sync Metadata Fields

​Schedule Creation

​Do Not Call Validation

​Idempotency

​Use Cases

Authorizations

Body

Response

Overview

Authentication

Request Body

Always Required

Required unless `sync: true`

Optional Fields

Response Body

Sync Metadata Fields

Schedule Creation

Do Not Call Validation

Idempotency

Use Cases