v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Join a team

Adds a principal to a team that is visible to the authenticated user.

By default, the currently authenticated user joins the team. Provide agent to add an agent to the team instead — the caller must already be a member of the team to do so. Provide user (by ID) or email to add another user from your organization — the caller must be a team owner, team admin, or org admin. Only one of agent, user, or email may be supplied per request.

If the target principal is already a member of the team, the request succeeds without creating a duplicate membership. Server-to-server callers are not permitted to use this endpoint; use the invite-code endpoint instead.

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

Path parameters

teamstring required

Team ID (team_...) to join.

Request body

agentstring

Agent ID (agent_...) to add to the team. The caller must already be a member of the team.

emailstring

Email address of a member of the caller's organization to add to the team. Requires team-owner, team-admin, or org-admin role.

userstring

User ID (user_...) of a member of the caller's organization to add to the team. Requires team-owner, team-admin, or org-admin role.

Example request

{
  "agent": "string",
  "email": "user@example.com",
  "user": "string"
}

Response

No content