Add Users to Team

This endpoint allows the addition of multiple users to a specified team by providing their user IDs. It is ideal for managing team membership and efficiently assigning multiple users to a team.

Key Features:

Add one or more users to a team.

Specify the creator of the request to track who added the users.

The request requires a valid team ID to identify the team to which users are being added.

Each user to be added must be identified by their user ID, and the email of the person adding users will be recorded.

How to View Your Team ID?

To find your Team ID*, follow the step-by-step guide here:
View Your Team ID

How to View Your User ID?

To find your User ID*, follow the step-by-step guide here:
View Your User ID

curl --location --request POST '/v2/api/team/242/users' \ --header 'Content-Type: application/json' \ --data-raw '{ "users": [ 2, 19 ], "created_by": "admin@example.com" }'

{ "success": true, "message": "Users added to team", "data": [ { "id": 667, "user": { "id": 2, "email": "user@example.com", "is_staff": true, "is_superuser": true, "is_active": true, "date_joined": "2024-01-20T01:38:19Z", "first_name": "Saad", "last_name": "Shaikh", "organization": { "id": 1, "org_name": "Data Science Dojo", "domain": "datasciencedojo.com", "org_logo_url": null, "org_icon_url": null, "is_deleted": false, "created_by": "System", "created_on": "2024-01-20T01:32:56.659642Z", "modified_by": "user@example.com", "modified_on": "2024-01-20T01:32:56.659663Z" } }, "role": "Viewer" } ] }

Request

Path Params

team_id

integer

required

Unique identifier of the team to which users will be added.

Example:

242

Body Params application/json

users

array[integer]

optional

List of user IDs to be added to the team.

Example:

[2,19]

created_by

string <email>

optional

Email of the user who is adding members to the team.

Example:

admin@example.com

Examples

Responses

🟢200OK

application/json

Users successfully added to the team.

Body

success

boolean

optional

Indicates whether the request was successful.

Example:

true

message

string

optional

Descriptive message about the response.

Example:

Users added to team

data

array [object {3}]

optional

List of added users and their roles in the team.

integer

optional

Unique identifier of the user-team association.

Example:

667

user

object

optional

Details of the added user.

role

string

optional

Role assigned to the user in the team.

Example:

Viewer

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

How to View Your Team ID?#

How to View Your User ID?#

Request

Responses

How to View Your Team ID?

How to View Your User ID?