Groups

Archive a group

DELETE/v1/groups/{id}

Archives a group that is no longer used. It must have no active members, no active subgroups and no programs that target it. An archived group drops out of List groups, and the rewards it led to keep their history.

Needs a key with the group:write scope.

Path parameters

idstring
The group's ID.

Response

200: The group is archived.

idstring
The group's ID.
statusstring
Always archived. Archiving an archived group changes nothing.

Errors

400API_QUERY_INVALID: A query parameter, or an ID in the path, is unknown or not in the right form.
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.
409GROUP_IN_USE: The group still has active members, active subgroups, or programs that target it.
429API_KEY_RATE_LIMITED: The key is over 600 requests a minute.

Update a group

Rename a group, change its type, or move it.

Add employees to groups

Put several people into several groups at once.

Request

curl -X DELETE "https://api.teambrite.com/v1/groups/{id}" \
  -H "Authorization: Bearer $TEAMBRITE_API_KEY"

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

Response

{
  "id": "grp_R4mW8cTqZ2nLx6VbK9hJd3Fs",
  "status": "archived"
}