Groups

Remove employees from groups

POST/v1/groups/remove-employees

Takes every employee you send out of every group you send. Employees who weren't in a group are skipped, so sending the same request again is safe. Programs that reached them only through these groups stop including them. Nothing changes unless every group and employee is found.

Needs a key with the group:write scope.

Body

groupIdsarray of strings
The groups, up to 50.
employeeIdsarray of strings
The employees, up to 1,000. Repeats are ignored.

Response

200: How many memberships ended.

removedinteger
Memberships this request ended. Employees who weren't in a group aren't counted.
groupsarray of objects
Each group you sent, in the same order.

Errors

400REQUEST_BODY_INVALID: The body has a field that is unknown, missing or out of range.
401API_KEY_INVALID: The key is missing, wrong, expired or revoked.
403API_KEY_SCOPE_MISSING: The key is valid but wasn't given the scope this endpoint needs. PLAN_UPGRADE_REQUIRED: Your plan doesn't include the API. COMPANY_CLOSED: Your company has closed its Teambrite account.
404GROUP_NOT_FOUND: Your company has no active group with this ID. EMPLOYEE_NOT_FOUND: No employee in your company has this ID.
411REQUEST_LENGTH_REQUIRED: The request didn't declare its length.
413REQUEST_TOO_LARGE: The body is over 1 MB.
429API_KEY_RATE_LIMITED: The key is over 600 requests a minute.

Add employees to groups

Put several people into several groups at once.

List upcoming rewards

Every reward due from today, day by day.

Request

curl -X POST "https://api.teambrite.com/v1/groups/remove-employees" \
  -H "Authorization: Bearer $TEAMBRITE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "groupIds": [
      "grp_R4mW8cTqZ2nLx6VbK9hJd3Fs"
    ],
    "employeeIds": [
      "emp_YY4BTQjWrhH4sQL1dRwjTpBw"
    ]
  }'

This changes real data, so run it from your own code.

Response

{
  "removed": 1,
  "groups": [
    {
      "groupId": "grp_R4mW8cTqZ2nLx6VbK9hJd3Fs",
      "removed": 1
    }
  ]
}