API V3Debtor
Updates the Debtor resource.
This endpoint updates an existing debtor. The body takes the same nested structure as POST /v3/debtors and merges per field: only fields present in the request body are updated, and a field sent as null clears its value. For example {"contact": {"email": null}} clears the email address and leaves the rest of the contact information untouched. The debtor_number itself cannot be changed.
The debtor is identified by the {debtor_number} path parameter and must belong to your account - otherwise the endpoint responds with 404.
The updated contact information is also propagated to collection orders that are already running for this debtor.
PATCH
/v3/debtors/{debtor_number}curl -X PATCH "/v3/debtors/{debtor_number}" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/merge-patch+json" \
-d '{
"iban": "NL02ABNA0123456789"
}'Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
debtor_numberstringpathrequiredDebtor identifier
Body
application/merge-patch+json
The updated Debtor resource
personalDebtorPersonalInput-debtor.write | nullcontactDebtorContactInput-debtor.write | nulladdressDebtorAddressInput-debtor.write | nullsecondary_addressDebtorAddressInput-debtor.write | nullibanstring | nullblock_messagingDebtorBlockMessagingInput-debtor.write | null
Response
application/json
Debtor resource updated
debtor_numberstring | nullpersonalDebtorPersonalOutput-debtor.read | nullcontactDebtorContactOutput-debtor.read | nulladdressDebtorAddressOutput-debtor.read | nullsecondary_addressDebtorAddressOutput-debtor.read | nullibanstring | nullblock_messagingDebtorBlockMessagingOutput-debtor.read | null
{
"debtor_number": "string",
"personal": {
"first_name": "string",
"last_name": "string",
"company_name": "string",
"personal_identification_number": "string",
"date_of_birth": "string",
"gender": "string",
"language": "string"
},
"contact": {
"email": "string",
"secondary_email": "string",
"phone_number": "string",
"secondary_phone_number": "string",
"mobile_number": "string"
},
"address": {
"street_name": "string",
"house_number": "string",
"zip_code": "string",
"city": "string",
"country": "string"
},
"secondary_address": {
"street_name": "string",
"house_number": "string",
"zip_code": "string",
"city": "string",
"country": "string"
},
"iban": "string",
"block_messaging": {
"email": true,
"sms": true,
"letter": true,
"call": true,
"home_visit": true
}
}