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 isActive flag is set to false and 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

id string required
Contact ID (e.g. cont_3). Must use the contact prefix.

Response

200 Contact deactivated (soft delete if linked invoices exist) or hard deleted if no invoices.
Show response fields
deactivated boolean
message string

Error codes

400 Invalid contact ID format.
404 Contact not found.