Skip to main content

Add persons to a group

This endpoint adds one or more persons to an existing group. The group and all of the persons must exist. The persons to be added to the group must always be an array in the request body, even if only one user is being added. All persons needs to be in the same region. A new group can be created with the POST /groups endpoint.

Path Parameters
  • group_name string required

    Possible values: Value must match regular expression ^[A-Za-z0-9]{1}[\w\.\-]{0,98}[A-Za-z0-9]$

    The name of a group

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Request Body required
  • persons string[] required

    List of person IDs to add to the group

Responses

The persons were successfully added to the group


Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string