Customers

Retires (deletes) a customer location.

Requires ManageCustomers and an Idempotency-Key header. The same delete as the Customers → Addresses page: the location is deactivated (isActive: false) rather than erased, so it stays on history and disappears from pickers; restore it with a PATCH of isActive: true. Refused with 409 while any job (in any status) references it.

delete/api/v1/customers/{id}/locations/{locationId}

Request

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

Path parameters

idinteger required

Customer id.

locationIdinteger required

Location id.

Response

The location was retired; 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.