Skip to content
/
Add an employee to a grou...

Add an employee to a group.

Request

Security
x-api-key
Path
idstringrequired

Unique identifier for the employee

Bodyapplication/jsonrequired

Add an employee to a group

groupstring, <= 100 charactersrequired

The name of the group.

Example:"Engineering team"
POST
/v1/employees/{id}/groups
curl -i -X POST \
  'https://api.pushsecurity.com/v1/employees/{id}/groups' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "group": "Engineering team"
  }'

Responses

OK. Returns all groups associated with the employee.

Bodyapplication/json
groupsArray of stringsrequired

The groups associated with the employee.

Example:
[
  "Engineering team",
  "Marketing team"
]
Response
{
  "groups": [
    "Engineering team",
    "Marketing team"
  ]
}