latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Associate practitioners with a group

Associates one or more practitioners with a group, creating group–practitioner membership records. Optionally also associates each practitioner with one or more specific locations within the group. Suitable for initial population as well as incremental additions. Idempotent — an UPSERT_DATA merge keyed on the group and practitioner, so calling again for an already-associated practitioner re-merges the supplied data into the existing association rather than creating a duplicate or returning a conflict.

post/groups/{id}/practitioners

Path parameters

idstring required

Group ID (tenantGroupId)

Headers

tenant-idstring

Request body

Example request

{
  "practitioners": [
    {
      "certifyPractitionerId": "prac-123",
      "locations": [
        {
          "tenantGroupLocationId": "loc-123"
        }
      ]
    }
  ]
}

Response

Practitioners successfully associated with the group

Example response

{
  "associations": [
    {
      "certifyPractitionerId": "prac-123",
      "tenantGroupPractitionerId": "tgp-789",
      "locations": [
        {
          "tenantGroupLocationId": "loc-123",
          "groupPractitionerLocationId": "gpl-456"
        }
      ]
    }
  ]
}