Docs
Skip to content
post

Create team

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/teams

Description

Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.

Required scopes

teams.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()), or authenticate as a signed-in user (setSession() or setJWT()). For direct REST calls, send X-Appwrite-Project with either X-Appwrite-Key or session/JWT headers.

Parameters

string
Required

Team ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string
Required

Team name. Max length: 128 chars.

array

Array of strings. Use this param to set the roles in the team for the user who created it. The default role is owner. A role can be any string. Learn more about roles and permissions. Maximum of 100 roles are allowed, each 32 characters long.

Status
Content type
201
application/json

Team

Name
Type
Description
string

Team ID.

string

Team creation date in ISO 8601 format.

string

Team update date in ISO 8601 format.

string

Team name.

integer

Total number of team members.

object

Team preferences as a key-value object Can be one of: preferences

JavaScript
const sdk = require('node-appwrite');


// Init SDK
const client = new sdk.Client();


const teams = new sdk.Teams(client);


client
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


const promise = teams.create('[TEAM_ID]', '[NAME]');


promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});