Deactivate a contact
DELETE
https://app.speybooks.com/api/v1/contacts/{id}Removes a contact from active use. The behaviour depends on whether the contact has linked invoices:
With invoices: The contact is soft-deleted (deactivated). The
isActiveflag is set tofalseand the contact is hidden from default list queries. All data and invoice relationships are preserved for audit and reporting.Without invoices: The contact is permanently deleted. This action is irreversible.
To reactivate a soft-deleted contact, use the update endpoint
to set isActive back to true.
Path parameters
idstringrequiredContact ID (e.g. cont_3). Must use the contact prefix.
Response
200Contact deactivated (soft delete if linked invoices exist) or hard deleted if no invoices.
Show response fields
deactivatedbooleanmessagestringError codes
400Invalid contact ID format.
404Contact not found.