Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Client Group

Add Clients to Group

Adds the given Clients to the specified Group. If a Client already belongs to another Group, they will be removed from their existing Group and added to the specified Group.

put/clients/group/{group_id}/participants

Path parameters

group_idinteger required

Id of the Group.

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Request body

Example request

{
  "group_participants": [
    {
      "group_participant_client_id": 1234567891234567,
      "group_role_id": 1234567891234567
    }
  ]
}

Response

Returns the updated Group data.

Example response

{
  "client_group": {
    "group_id": 1234567891234567,
    "group_participants": [
      {
        "group_participant_client_id": 1234567891234567,
        "group_role_id": 1234567891234567
      }
    ]
  }
}