Update a debtor
curl --request PATCH \
--url https://collectwiseapi.com/debtor/{debtorId} \
--header 'Content-Type: application/json' \
--header 'collectwise_key: <api-key>' \
--data '
{
"debtorName": "<string>",
"totalUnpaidDebt": 123,
"delinquencyDate": "2023-12-25",
"phoneNumber": "<string>",
"email": "jsmith@example.com",
"callbackNumber": "<string>",
"productOrService": "<string>",
"creditorName": "<string>",
"accountNumber": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"ssn": "<string>",
"lastPayDate": "2023-12-25",
"chargeOffDate": "2023-12-25",
"interestDue": 123,
"principalDue": 123,
"otherFees": 123,
"amountPaid": 123,
"customization": "<string>"
}
'import requests
url = "https://collectwiseapi.com/debtor/{debtorId}"
payload = {
"debtorName": "<string>",
"totalUnpaidDebt": 123,
"delinquencyDate": "2023-12-25",
"phoneNumber": "<string>",
"email": "jsmith@example.com",
"callbackNumber": "<string>",
"productOrService": "<string>",
"creditorName": "<string>",
"accountNumber": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"ssn": "<string>",
"lastPayDate": "2023-12-25",
"chargeOffDate": "2023-12-25",
"interestDue": 123,
"principalDue": 123,
"otherFees": 123,
"amountPaid": 123,
"customization": "<string>"
}
headers = {
"collectwise_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {collectwise_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
debtorName: '<string>',
totalUnpaidDebt: 123,
delinquencyDate: '2023-12-25',
phoneNumber: '<string>',
email: 'jsmith@example.com',
callbackNumber: '<string>',
productOrService: '<string>',
creditorName: '<string>',
accountNumber: '<string>',
address: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
ssn: '<string>',
lastPayDate: '2023-12-25',
chargeOffDate: '2023-12-25',
interestDue: 123,
principalDue: 123,
otherFees: 123,
amountPaid: 123,
customization: '<string>'
})
};
fetch('https://collectwiseapi.com/debtor/{debtorId}', 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://collectwiseapi.com/debtor/{debtorId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'debtorName' => '<string>',
'totalUnpaidDebt' => 123,
'delinquencyDate' => '2023-12-25',
'phoneNumber' => '<string>',
'email' => 'jsmith@example.com',
'callbackNumber' => '<string>',
'productOrService' => '<string>',
'creditorName' => '<string>',
'accountNumber' => '<string>',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'ssn' => '<string>',
'lastPayDate' => '2023-12-25',
'chargeOffDate' => '2023-12-25',
'interestDue' => 123,
'principalDue' => 123,
'otherFees' => 123,
'amountPaid' => 123,
'customization' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"collectwise_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://collectwiseapi.com/debtor/{debtorId}"
payload := strings.NewReader("{\n \"debtorName\": \"<string>\",\n \"totalUnpaidDebt\": 123,\n \"delinquencyDate\": \"2023-12-25\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"callbackNumber\": \"<string>\",\n \"productOrService\": \"<string>\",\n \"creditorName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"ssn\": \"<string>\",\n \"lastPayDate\": \"2023-12-25\",\n \"chargeOffDate\": \"2023-12-25\",\n \"interestDue\": 123,\n \"principalDue\": 123,\n \"otherFees\": 123,\n \"amountPaid\": 123,\n \"customization\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("collectwise_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.patch("https://collectwiseapi.com/debtor/{debtorId}")
.header("collectwise_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"debtorName\": \"<string>\",\n \"totalUnpaidDebt\": 123,\n \"delinquencyDate\": \"2023-12-25\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"callbackNumber\": \"<string>\",\n \"productOrService\": \"<string>\",\n \"creditorName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"ssn\": \"<string>\",\n \"lastPayDate\": \"2023-12-25\",\n \"chargeOffDate\": \"2023-12-25\",\n \"interestDue\": 123,\n \"principalDue\": 123,\n \"otherFees\": 123,\n \"amountPaid\": 123,\n \"customization\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://collectwiseapi.com/debtor/{debtorId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["collectwise_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"debtorName\": \"<string>\",\n \"totalUnpaidDebt\": 123,\n \"delinquencyDate\": \"2023-12-25\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"callbackNumber\": \"<string>\",\n \"productOrService\": \"<string>\",\n \"creditorName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"ssn\": \"<string>\",\n \"lastPayDate\": \"2023-12-25\",\n \"chargeOffDate\": \"2023-12-25\",\n \"interestDue\": 123,\n \"principalDue\": 123,\n \"otherFees\": 123,\n \"amountPaid\": 123,\n \"customization\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"debtorId": "<string>",
"debtorName": "<string>",
"totalUnpaidDebt": 123,
"delinquencyDate": "2023-12-25",
"creditorName": "<string>",
"lastUpdated": "2023-11-07T05:31:56Z",
"phoneNumber": "<string>",
"email": "jsmith@example.com",
"callbackNumber": "<string>",
"productOrService": "<string>",
"creditorEmail": "jsmith@example.com",
"accountNumber": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"county": "<string>",
"ssn": "<string>",
"lastPayDate": "2023-12-25",
"chargeOffDate": "2023-12-25",
"interestDue": 123,
"principalDue": 123,
"otherFees": 123,
"amountPaid": 123,
"paymentLink": "<string>",
"customWorkflowID": "<string>",
"enrollment": {
"attempted": true,
"success": true,
"message": "<string>",
"workflowId": "<string>",
"agentName": "<string>"
},
"customization": "<string>"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"error": "Too many requests"
}Debtors
Update Debtor
Update an existing debtor’s information
PATCH
/
debtor
/
{debtorId}
Update a debtor
curl --request PATCH \
--url https://collectwiseapi.com/debtor/{debtorId} \
--header 'Content-Type: application/json' \
--header 'collectwise_key: <api-key>' \
--data '
{
"debtorName": "<string>",
"totalUnpaidDebt": 123,
"delinquencyDate": "2023-12-25",
"phoneNumber": "<string>",
"email": "jsmith@example.com",
"callbackNumber": "<string>",
"productOrService": "<string>",
"creditorName": "<string>",
"accountNumber": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"ssn": "<string>",
"lastPayDate": "2023-12-25",
"chargeOffDate": "2023-12-25",
"interestDue": 123,
"principalDue": 123,
"otherFees": 123,
"amountPaid": 123,
"customization": "<string>"
}
'import requests
url = "https://collectwiseapi.com/debtor/{debtorId}"
payload = {
"debtorName": "<string>",
"totalUnpaidDebt": 123,
"delinquencyDate": "2023-12-25",
"phoneNumber": "<string>",
"email": "jsmith@example.com",
"callbackNumber": "<string>",
"productOrService": "<string>",
"creditorName": "<string>",
"accountNumber": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"ssn": "<string>",
"lastPayDate": "2023-12-25",
"chargeOffDate": "2023-12-25",
"interestDue": 123,
"principalDue": 123,
"otherFees": 123,
"amountPaid": 123,
"customization": "<string>"
}
headers = {
"collectwise_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {collectwise_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
debtorName: '<string>',
totalUnpaidDebt: 123,
delinquencyDate: '2023-12-25',
phoneNumber: '<string>',
email: 'jsmith@example.com',
callbackNumber: '<string>',
productOrService: '<string>',
creditorName: '<string>',
accountNumber: '<string>',
address: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
ssn: '<string>',
lastPayDate: '2023-12-25',
chargeOffDate: '2023-12-25',
interestDue: 123,
principalDue: 123,
otherFees: 123,
amountPaid: 123,
customization: '<string>'
})
};
fetch('https://collectwiseapi.com/debtor/{debtorId}', 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://collectwiseapi.com/debtor/{debtorId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'debtorName' => '<string>',
'totalUnpaidDebt' => 123,
'delinquencyDate' => '2023-12-25',
'phoneNumber' => '<string>',
'email' => 'jsmith@example.com',
'callbackNumber' => '<string>',
'productOrService' => '<string>',
'creditorName' => '<string>',
'accountNumber' => '<string>',
'address' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'ssn' => '<string>',
'lastPayDate' => '2023-12-25',
'chargeOffDate' => '2023-12-25',
'interestDue' => 123,
'principalDue' => 123,
'otherFees' => 123,
'amountPaid' => 123,
'customization' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"collectwise_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://collectwiseapi.com/debtor/{debtorId}"
payload := strings.NewReader("{\n \"debtorName\": \"<string>\",\n \"totalUnpaidDebt\": 123,\n \"delinquencyDate\": \"2023-12-25\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"callbackNumber\": \"<string>\",\n \"productOrService\": \"<string>\",\n \"creditorName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"ssn\": \"<string>\",\n \"lastPayDate\": \"2023-12-25\",\n \"chargeOffDate\": \"2023-12-25\",\n \"interestDue\": 123,\n \"principalDue\": 123,\n \"otherFees\": 123,\n \"amountPaid\": 123,\n \"customization\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("collectwise_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.patch("https://collectwiseapi.com/debtor/{debtorId}")
.header("collectwise_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"debtorName\": \"<string>\",\n \"totalUnpaidDebt\": 123,\n \"delinquencyDate\": \"2023-12-25\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"callbackNumber\": \"<string>\",\n \"productOrService\": \"<string>\",\n \"creditorName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"ssn\": \"<string>\",\n \"lastPayDate\": \"2023-12-25\",\n \"chargeOffDate\": \"2023-12-25\",\n \"interestDue\": 123,\n \"principalDue\": 123,\n \"otherFees\": 123,\n \"amountPaid\": 123,\n \"customization\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://collectwiseapi.com/debtor/{debtorId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["collectwise_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"debtorName\": \"<string>\",\n \"totalUnpaidDebt\": 123,\n \"delinquencyDate\": \"2023-12-25\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"callbackNumber\": \"<string>\",\n \"productOrService\": \"<string>\",\n \"creditorName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"ssn\": \"<string>\",\n \"lastPayDate\": \"2023-12-25\",\n \"chargeOffDate\": \"2023-12-25\",\n \"interestDue\": 123,\n \"principalDue\": 123,\n \"otherFees\": 123,\n \"amountPaid\": 123,\n \"customization\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"debtorId": "<string>",
"debtorName": "<string>",
"totalUnpaidDebt": 123,
"delinquencyDate": "2023-12-25",
"creditorName": "<string>",
"lastUpdated": "2023-11-07T05:31:56Z",
"phoneNumber": "<string>",
"email": "jsmith@example.com",
"callbackNumber": "<string>",
"productOrService": "<string>",
"creditorEmail": "jsmith@example.com",
"accountNumber": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"county": "<string>",
"ssn": "<string>",
"lastPayDate": "2023-12-25",
"chargeOffDate": "2023-12-25",
"interestDue": 123,
"principalDue": 123,
"otherFees": 123,
"amountPaid": 123,
"paymentLink": "<string>",
"customWorkflowID": "<string>",
"enrollment": {
"attempted": true,
"success": true,
"message": "<string>",
"workflowId": "<string>",
"agentName": "<string>"
},
"customization": "<string>"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"code": 400,
"message": "Invalid input: debtorName is required"
}{
"error": "Too many requests"
}Authorizations
Active, unexpired API key belonging to an active organization. Optional organization/key signing and organization IP restrictions also apply; see API Access.
Headers
Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.
Pattern:
^(0|[1-9][0-9]*)$CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.
Pattern:
^v1=[0-9a-f]{64}$Path Parameters
Unique identifier of the debtor to update
Body
application/json
Updated debtor information
Updated name of the debtor
Updated total unpaid debt amount
Updated date when the debt became delinquent
Updated contact phone number of the debtor
Updated email address of the debtor
Updated callback phone number
Updated name of the product or service delivered to the debtor
Updated name of the creditor
Updated account number associated with the debt
Updated street address of the debtor
Updated city of the debtor
Updated state of the debtor
Updated ZIP code of the debtor
Updated Social Security Number of the debtor
Updated date of the last payment made by the debtor
Updated date when the debt was charged off, if applicable
Updated amount of interest due on the debt
Updated amount of principal due on the debt
Updated other fees associated with the debt
Updated total amount paid by the debtor so far
Custom instructions for AI collection workflow (e.g., tone, channel preferences, frequency). If not provided, the system will generate an optimal collection flow.
Response
Debtor updated successfully
Unique identifier of the debtor
Full name of the debtor
Total amount of unpaid debt
Date when the debt became delinquent
Name of the creditor
Timestamp of the last update to this record
Contact phone number of the debtor
Email address of the debtor
Callback phone number
Name of the product or service delivered to the debtor
Creditor email if provided
Account number associated with the debt
Street address of the debtor
City of the debtor
State of the debtor
ZIP code of the debtor
County of the debtor
Social Security Number of the debtor
Date of the last payment made by the debtor
Date when the debt was charged off, if applicable
Amount of interest due on the debt
Amount of principal due on the debt
Other fees associated with the debt
Total amount paid by the debtor so far
Payment link associated with the debtor
Custom workflow identifier for the debtor
Present only when customWorkflowID is provided
Show child attributes
Show child attributes
Custom instructions for AI collection workflow (e.g., tone, channel preferences, frequency). If not provided, the system will generate an optimal collection flow.