Skip to main content

Update the status or compliance flags of a debt

PATCH 

/v1/debts/:debt_id

Partial update of status and the compliance flags. Any other field, such as a balance, a creditor or debt_external_id, returns 400: the subscriber upload and NBA own those fields. NBA writes the same flags from conversations, and the last write wins.

To mark a debt as paid, send status: paid, and optionally how it was paid: payment_method, payment_reference and payment_evidence. The payment fields are not stored on the debt. They are recorded on the status change in GET /v1/debts/{debt_id}/events, so they need status and record nothing when the status does not change. When a debt moves from an open status to paid or settled, every active subscriber of an in-progress agentic campaign that holds it gets a new NBA evaluation, so the campaign can stop or work the debts that are still open. To undo a wrong paid, send status: active.

Permissions - contacts.read + debts.write. Setting a compliance flag from true to false also needs debts.delete. API keys - manage. A change made with an API key names the key's creator as the actor.

Request​

Responses​

The debt with the contacts linked to it