---
title: "Change the collection preferences for a customer"
method: PATCH
path: "/customers/{customerId}/collection_preferences"
tags: ["Customers"]
---

# Change the collection preferences for a customer

`PATCH /customers/{customerId}/collection_preferences`

## Request

- Base URL: `https://api.adfin.com/api`
- URL: `https://api.adfin.com/api/customers/{customerId}/collection_preferences`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.staging.adfin.com/api/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.adfin.com/api/oauth2/token`

A field left out of the body is unchanged. `partialPayments` takes at most one of `minimumAmount` or `minimumPercentage`.

## Path parameters

- `customerId` string, uuid, required

## Request body

- PatchCollectionPreferencesRequest: The collection method and preferences to change. Anything left out is unchanged.
  - `collectionMethod` 'AUTO_COLLECT' | 'ON_DEMAND': The collection method to use.
  - `preferences` CollectionPreferences: The collection preferences that can be set for an entity.
    - `paymentReminders` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `paymentDistribution` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `mandateReminders` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `cardReminders` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `directDebitEncouragement` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `statements` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.
    - `lateFees` LateFeesPreference: Whether late fees are charged, and when they become chargeable.
      - `enabled` boolean, required: Whether the agent charges late fees.
      - `gracePeriodDays` integer: Days after the due date before a late fee becomes chargeable.
    - `partialPayments` PartialPaymentsPreference: Whether the customer may pay in parts, and the smallest part accepted.
      - `enabled` boolean, required: Whether the agent accepts part payments.
      - `minimumAmount` number: Smallest part payment accepted, as a fixed amount. `0` accepts any amount.
      - `minimumPercentage` number: Smallest part payment accepted, as a percentage of the total.
    - `surcharging` PreferenceToggle: A preference the agent either applies or does not.
      - `enabled` boolean, required: Whether the agent applies this preference.

## Response `204`

The change was applied.

## Other responses

- `400`: `errors[].type` is `COLLECTION_METHOD_NOT_ELIGIBLE` when that method cannot be used here, or `DIRECT_DEBIT_NOT_AVAILABLE` when `AUTO_COLLECT` has no usable mandate. A body that does not match the schema is refused here too.
- `401`: The request carried no valid access token.
- `403`: The access token does not grant updating customers.
- `404`: There is no customer with that identifier.
- `422`: Nothing was changed. `errors[].type` is `NO_CHANGES_SUPPLIED` when the body carries no setting, `SETTING_NOT_AVAILABLE_FOR_ENTITY` when a setting is not honoured for this entity, `SETTING_CANNOT_BE_ENABLED` when Adfin holds no settings to apply, or `NO_AGENT_DEFINED` when no agent collects for the customer.
- `500`: The server could not process the request.

## Changes

- **2026-10-19** `ba2d7a1f310e`: 1 info
  - added the new optional request property `preferences/paymentDistribution`
- **2026-10-06** `cbec1c02c8cf`: 3 warning
  - the `preferences/partialPayments/minimumPercentage` request property's exclusiveMinimum was set to `0.00`
  - the `preferences/lateFees/gracePeriodDays` request property's min was set to `0.00`
  - the `preferences/partialPayments/minimumAmount` request property's min was set to `0.00`
- **2026-09-10** `538c9ec3d4d4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/adfin/apis/adfin-api/changes/customers/:customerId/collection_preferences/patch.md)

---

[API](https://skmtc.dev/adfin/apis/adfin-api.md) - [All operations](https://skmtc.dev/adfin/apis/adfin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/adfin/apis/adfin-api/revisions/3bcc12f59ff0?raw)