Create Team

Creates a new team for the authenticated user, populated with the given team members. Hidden teams can not be created via the REST API.

šŸ“˜

Whether the requesting user is automatically added to the team depends on whether the request was made using user or admin permissions.

  • User: user is automatically added to the team
    • Must request with a user grant/scope and either omit the header Lucid-Request-As or contain the value user.
  • Admin: user is not automatically added to the team
    • 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

Body Params
string
required
string
enum
required
Allowed:
users
array of integers
required
users*
Headers
string
required
Defaults to 1
string
Responses

400

Bad Request. Occurs if the name in the request body is empty or exceeds the maximum allowed length.

403

Forbidden. Occurs if the user making the request does not have permission to create teams.

409

Conflict. Occurs if a team already exists with an identical name.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json