Add Users to Team

Adds users to a specified team with assigned roles. With user permissions, the team must be one the requesting user has edit access to. With admin permissions, users can be added to any team belonging to the account.

Adds users to a given team, provided the authenticated user has edit access to that team. Users may be added to additional teams by using admin permissions (see below).

📘

The teams to which users can be added depend on whether the request is made using user or admin permissions.

  • User: team must be one that the requesting user has edit access to
    • Must request with a user grant/scope and either omit the header Lucid-Request-As or contain the value user.
  • Admin: team must belong to the account
    • Must request with an admin grant/scope and contain the header Lucid-Request-As with value admin.

Valid Authentication Methods

API Key Grants:

TeamsEdit

TeamsAdmin

OAuth 2.0 User Token Scopes:

teams

teams:admin


Path Params
number
required

ID of the team to which to add users.

Body Params
users
array of objects
required

Array of users with their assigned roles to add to the team

users*
Headers
string

If the requesting user is an account owner, team admin, or team manager with the required permissions and they make
the request with the value of “admin” as this header and include an admin scope, the request will be made using
their admin permissions.

Responses
204

No Content. The users were successfully added to the team with their assigned roles. If requesting as admin, users may have been added even though the authenticated user does not have direct access to the specified team.

403

Forbidden. if not all the specified users are on the authenticated account. if the user making the request does not have permission to edit teams. if the user making the request does not have access to the specified team. if the team is managed via SCIM. Use the SCIM Groups API to modify SCIM-managed teams.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!