Update Debtor

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": "[email protected]",
  "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>"
}
'

{
  "debtorId": "<string>",
  "debtorName": "<string>",
  "totalUnpaidDebt": 123,
  "delinquencyDate": "2023-12-25",
  "creditorName": "<string>",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "phoneNumber": "<string>",
  "email": "[email protected]",
  "callbackNumber": "<string>",
  "productOrService": "<string>",
  "creditorEmail": "[email protected]",
  "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,
  "customWorkflowID": "<string>",
  "enrollment": {
    "attempted": true,
    "success": true,
    "message": "<string>",
    "workflowId": "<string>",
    "agentName": "<string>"
  },
  "customization": "<string>"
}

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": "[email protected]",
  "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>"
}
'

{
  "debtorId": "<string>",
  "debtorName": "<string>",
  "totalUnpaidDebt": 123,
  "delinquencyDate": "2023-12-25",
  "creditorName": "<string>",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "phoneNumber": "<string>",
  "email": "[email protected]",
  "callbackNumber": "<string>",
  "productOrService": "<string>",
  "creditorEmail": "[email protected]",
  "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,
  "customWorkflowID": "<string>",
  "enrollment": {
    "attempted": true,
    "success": true,
    "message": "<string>",
    "workflowId": "<string>",
    "agentName": "<string>"
  },
  "customization": "<string>"
}

Authorizations

collectwise_key

string

header

required

Path Parameters

debtorId

string

required

Unique identifier of the debtor to update

Body

application/json

Updated debtor information

debtorName

string

Updated name of the debtor

totalUnpaidDebt

number<float>

Updated total unpaid debt amount

delinquencyDate

string<date>

Updated date when the debt became delinquent

phoneNumber

string

Updated contact phone number of the debtor

string<email>

Updated email address of the debtor

callbackNumber

string

Updated callback phone number

productOrService

string

Updated name of the product or service delivered to the debtor

creditorName

string

Updated name of the creditor

accountNumber

string

Updated account number associated with the debt

address

string

Updated street address of the debtor

city

string

Updated city of the debtor

state

string

Updated state of the debtor

zipCode

string

Updated ZIP code of the debtor

ssn

string

Updated Social Security Number of the debtor

lastPayDate

string<date>

Updated date of the last payment made by the debtor

chargeOffDate

string<date>

Updated date when the debt was charged off, if applicable

interestDue

number<float>

Updated amount of interest due on the debt

principalDue

number<float>

Updated amount of principal due on the debt

otherFees

number<float>

Updated other fees associated with the debt

amountPaid

number<float>

Updated total amount paid by the debtor so far

customization

string

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

debtorId

string

required

Unique identifier of the debtor

debtorName

string

required

Full name of the debtor

totalUnpaidDebt

number<float>

required

Total amount of unpaid debt

delinquencyDate

string<date>

required

Date when the debt became delinquent

creditorName

string

required

Name of the creditor

lastUpdated

string<date-time>

required

Timestamp of the last update to this record

phoneNumber

string

Contact phone number of the debtor

string<email>

Email address of the debtor

callbackNumber

string

Callback phone number

productOrService

string

Name of the product or service delivered to the debtor

creditorEmail

string<email>

Creditor email if provided

accountNumber

string

Account number associated with the debt

address

string

Street address of the debtor

city

string

City of the debtor

state

string

State of the debtor

zipCode

string

ZIP code of the debtor

county

string

County of the debtor

ssn

string

Social Security Number of the debtor

lastPayDate

string<date>

Date of the last payment made by the debtor

chargeOffDate

string<date>

Date when the debt was charged off, if applicable

interestDue

number<float>

Amount of interest due on the debt

principalDue

number<float>

Amount of principal due on the debt

otherFees

number<float>

Other fees associated with the debt

amountPaid

number<float>

Total amount paid by the debtor so far

customWorkflowID

string

Custom workflow identifier for the debtor

enrollment

object

Present only when customWorkflowID is provided

Show child attributes

enrollment.attempted

boolean

enrollment.success

boolean

enrollment.message

string

enrollment.workflowId

string

enrollment.agentName

string

Agent name passed in the request. This is echoed back; if not provided, the service falls back internally to merchantName/email, but only the raw agentName is returned here.

customization

string

Custom instructions for AI collection workflow (e.g., tone, channel preferences, frequency). If not provided, the system will generate an optimal collection flow.

Bulk Create Debtors Get Debtor

⌘I

Get Started

Debtors

Debtor Status

Webhooks

Communications

Workflow

Authorizations

Path Parameters

Body

Response