teams

Add multiple users to a team at once

Adds every listed user. Users already in the team, not found, or not in the org are skipped; the response holds only the members added.

post/teams/{id}/members/bulk

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring required

Request body

userIdsstring[] required

The user IDs to add to the team

Example request

{
  "userIds": [
    "550e8400-e29b-41d4-a716-446655440001",
    "550e8400-e29b-41d4-a716-446655440002"
  ]
}

Response

Users successfully added to team

idstring required

The unique identifier of the team member

userIdstring required

The user ID of the team member

userNamestring required

The name of the team member

userEmailstring required

The email of the team member

userRole'admin' | 'manager' | 'user' required

The role of the team member in the organization

joinedAtstring date-time required

The date when the user joined the team

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "550e8400-e29b-41d4-a716-446655440001",
    "userName": "John Doe",
    "userEmail": "john.doe@example.com",
    "userRole": "user",
    "joinedAt": "2024-01-15T10:30:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 51 revisions of this API.