July 8, 2026

Manage Team membership

Following on from the read-only Team endpoints, you can now add and remove Team members through the API.

POST /v3/Teams/{TeamKey}/AddMembers adds one or more users to a team.

POST /v3/Teams/2Nw8tnxwQCVf/AddMembers
Content-Type: application/json

{
  "UserKeys": ["3VQ8Qrq944NW", "4WR9Srq055PX"]
}

Returns 204 No Content on success. Users already on the team are skipped, so re-sending the same request is safe. If any key does not match an active user, no members are added and the response is 400 Bad Request listing every key that could not be found:

{
  "error": {
    "code": "4002",
    "message": "Cannot find an active user for 3VQ8Qrq944NW"
  }
}

POST /v3/Teams/{TeamKey}/RemoveMember removes a single user from a team.

POST /v3/Teams/2Nw8tnxwQCVf/RemoveMember
Content-Type: application/json

{
  "UserKey": "3VQ8Qrq944NW"
}

Returns 204 No Content whether or not the user was a member of the team, so this is also safe to retry.

Both endpoints return 404 Not Found when TeamKey does not match an existing team.

These endpoints only manage individual users. A Team can contain another Team as a sub-team (shown as a Team-type entry in Members), but adding or removing a sub-team is not yet supported through the API — this can only be done in the Karbon app.