Customers

Deletes a customer.

Requires ManageCustomers and an Idempotency-Key header. This is the same soft delete as the Customers page: the customer disappears from every list and lookup (GETs answer 404) but keeps its history, and a user can restore it from Customers → Deleted Customers in the app. The delete is refused with 409 while the customer still has active jobs (not Completed/Cancelled), unpaid invoices (not Paid/Cancelled) or active sales orders — complete or cancel those first; the problem detail names which. To merely hide a customer from pickers without deleting it, PUT it with isActive: false instead.

delete/api/v1/customers/{id}

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/customers/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Customer id.

Response

The customer was deleted; body carries its id and a confirmation message.

idinteger

Id of the resource the operation acted on (e.g. the job id).

messagestring nullable

Human-readable confirmation from the service (e.g. "Job started."). May be null.

warningstring nullable

Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

Changes

No recorded changes to this operation across all 1 revision of this API.