API changelog release 26.05 (May)

Release 26.05 introduces a single-call workflow for creating a debtor contact together with its billing address and announces an upcoming validation change scheduled for release 26.06. Review the changes below to assess the impact on your integration.

Important changes

Upcoming breaking change in release 26.06 — default_billing_address will be required for debtors: Starting in release 26.06, POST /api/v3/contacts/ and PUT /api/v3/contacts/{id}/ will reject debtor payloads that do not include a default_billing_address, returning HTTP 400. This brings the API workflow in line with the UI workflow for creating a debtor, and prevents synchronization errors when using external software.

The single-call workflow shipped in release 26.05 (see below under Modified endpoints) is the recommended migration path: it lets you create a debtor and its billing address atomically in one request. Migrate any integration that creates debtors to include default_billing_address in the same call before release 26.06.

Modified endpoints

Create a debtor and its billing address in a single call

POST /api/v3/contacts/ and PUT /api/v3/contacts/{id}/ accept an inline address object on default_billing_address, in addition to the existing hyperlinked URL reference to an existing address. When an inline object is supplied, the contact and address are created in the same transaction; if either fails, neither is persisted.

This enables creating a debtor contact and its billing address in a single call, matching the atomicity of the Legalsense UI. It also enables promoting a non-debtor contact to a debtor in one PUT request, by combining is_debtor: true with an inline default_billing_address.

The validation that an address must already belong to the contact has been relaxed: contact-less addresses and inline-create payloads are accepted. Addresses belonging to a different contact still return HTTP 400, with the error message "Address does not belong to this contact."

Clearing optional user fields via the API

PUT /api/v3/users/{id}/ accepts an explicit null on end_date, employee_number, recofa_begin_date, and recofa_sworn_in_date, and clears the stored value. Use this to clear these fields via the API when a workflow requires it, such as a re-hire flow that needs to reset end_date.

Already backported to release 26.04; customers on the latest 26.04 patch have the fix.

For more information about Legalsense features, please visit our knowledge base.