Skip to main content
PATCH
Add and remove clients in a client group

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

client_group_id
integer
required

The ID of the client group.

Body

application/json
clients_to_add
integer[]

IDs of clinic clients to add to the client group. At most 500 IDs.

Maximum array length: 500
clients_to_remove
integer[]

IDs of clinic clients to remove from the client group. At most 500 IDs.

Maximum array length: 500

Response

200 - application/json

OK

The per-ID outcome of a client group membership update.

clients_to_add
ClientGroupMembershipListResult · object
required

The outcome for each ID in clients_to_add.

clients_to_remove
ClientGroupMembershipListResult · object
required

The outcome for each ID in clients_to_remove.