v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Create a team invite

Generates a new invite code for the specified team. The authenticated user must be a member of the team with the owner or admin role.

The returned code is a short alphanumeric string that other users can present to join the team. Each call produces a new code; previously issued codes are not invalidated by this request.

post/api/v1/teams/{team}/invite

Path parameters

teamstring required

Team ID (tm_...) identifying the team for which to generate the invite code.

Response

Successful response

codestring required

Short alphanumeric join code. Pass this value as join_code to the join-with-code endpoint to add a user to the team.

Example response

{
  "code": "XKCD42"
}