Sign in
Practitioners

Reorder practitioners for a site

Reorders the practitioners at a site in one request. The order of practitioner_ids in the body determines each practitioner's order field (first ID → order: 0, second → order: 1, etc.). IDs not listed are unaffected and keep their existing order.

Returns the full ordered list (same shape as the GET response) so callers can re-render without a follow-up fetch.

Requires the SETTINGS_MANAGE permission on the site.

put/shop/practitioners/order

Request body

site_idstring uuid required

ID of the site whose practitioners are being reordered. All practitioner_ids must belong to this site.

practitioner_idsstring[] required

Practitioner IDs in the desired display order. Index in the array becomes the practitioner's order field.

Example request

{
  "site_id": "6f1234567890abcdef123456"
}

Response

The reordered list of practitioners.

Example response

{
  "data": [
    {
      "id": "5dcb47800000000000000000",
      "name": "Jane Doe"
    }
  ]
}

Changes

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