Bulk Create Debtors

Create multiple debtors

curl --request POST \
  --url https://collectwiseapi.com/debtors \
  --header 'Content-Type: application/json' \
  --header 'collectwise_key: <api-key>' \
  --data '
[
  {
    "debtorName": "<string>",
    "totalUnpaidDebt": 123,
    "delinquencyDate": "2023-12-25",
    "phoneNumber": "<string>",
    "email": "[email protected]",
    "productOrService": "<string>",
    "creditorName": "<string>",
    "callbackNumber": "<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>",
    "agentName": "<string>",
    "customization": "<string>"
  }
]
'

{
  "createdDebtors": [
    {
      "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>"
    }
  ],
  "failedDebtors": [
    {
      "index": 123,
      "error": {
        "code": 400,
        "message": "Invalid input: debtorName is required"
      }
    }
  ]
}

POST

debtors

Create multiple debtors

curl --request POST \
  --url https://collectwiseapi.com/debtors \
  --header 'Content-Type: application/json' \
  --header 'collectwise_key: <api-key>' \
  --data '
[
  {
    "debtorName": "<string>",
    "totalUnpaidDebt": 123,
    "delinquencyDate": "2023-12-25",
    "phoneNumber": "<string>",
    "email": "[email protected]",
    "productOrService": "<string>",
    "creditorName": "<string>",
    "callbackNumber": "<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>",
    "agentName": "<string>",
    "customization": "<string>"
  }
]
'

{
  "createdDebtors": [
    {
      "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>"
    }
  ],
  "failedDebtors": [
    {
      "index": 123,
      "error": {
        "code": 400,
        "message": "Invalid input: debtorName is required"
      }
    }
  ]
}

Authorizations

collectwise_key

string

header

required

Body

application/json

Array of debtor information to add

Minimum array length: 1

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

phoneNumber

string

required

Contact phone number of the debtor

string<email>

required

Email address of the debtor

productOrService

string

required

Name of the product or service delivered to the debtor

creditorName

string

required

Name of the creditor

callbackNumber

string

Callback phone number

creditorEmail

string<email>

Email address of the creditor

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

agentName

string

Name of the agent to attribute workflow enrollment to

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

Bulk debtor creation response

createdDebtors

object[]

Show child attributes

createdDebtors.debtorId

string

required

Unique identifier of the debtor

createdDebtors.debtorName

string

required

Full name of the debtor

createdDebtors.totalUnpaidDebt

number<float>

required

Total amount of unpaid debt

createdDebtors.delinquencyDate

string<date>

required

Date when the debt became delinquent

createdDebtors.creditorName

string

required

Name of the creditor

createdDebtors.lastUpdated

string<date-time>

required

Timestamp of the last update to this record

createdDebtors.phoneNumber

string

Contact phone number of the debtor

createdDebtors.email

string<email>

Email address of the debtor

createdDebtors.callbackNumber

string

Callback phone number

createdDebtors.productOrService

string

Name of the product or service delivered to the debtor

createdDebtors.creditorEmail

string<email>

Creditor email if provided

createdDebtors.accountNumber

string

Account number associated with the debt

createdDebtors.address

string

Street address of the debtor

createdDebtors.city

string

City of the debtor

createdDebtors.state

string

State of the debtor

createdDebtors.zipCode

string

ZIP code of the debtor

createdDebtors.county

string

County of the debtor

createdDebtors.ssn

string

Social Security Number of the debtor

createdDebtors.lastPayDate

string<date>

Date of the last payment made by the debtor

createdDebtors.chargeOffDate

string<date>

Date when the debt was charged off, if applicable

createdDebtors.interestDue

number<float>

Amount of interest due on the debt

createdDebtors.principalDue

number<float>

Amount of principal due on the debt

createdDebtors.otherFees

number<float>

Other fees associated with the debt

createdDebtors.amountPaid

number<float>

Total amount paid by the debtor so far

createdDebtors.customWorkflowID

string

Custom workflow identifier for the debtor

createdDebtors.enrollment

object

Present only when customWorkflowID is provided

Show child attributes

createdDebtors.enrollment.attempted

boolean

createdDebtors.enrollment.success

boolean

createdDebtors.enrollment.message

string

createdDebtors.enrollment.workflowId

string

createdDebtors.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.

createdDebtors.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.

failedDebtors

object[]

Show child attributes

failedDebtors.index

integer

Index of the failed debtor in the input array

failedDebtors.error

object

Show child attributes

failedDebtors.error.code

integer<int32>

required

Error code

failedDebtors.error.message

string

required

Error message

Example:

{
  "code": 400,
  "message": "Invalid input: debtorName is required"
}

Create Debtor Update Debtor

⌘I

Get Started

Debtors

Debtor Status

Webhooks

Communications

Workflow

Authorizations

Body

Response