v11

latestOpenAPI 3.1.12026-08-03174162.0 MB

Team Members

Add an existing user to a team

Directly add an existing user to a team. Team key can be ID or slug. Requires at least one role ID. To invite a new user by email, use the team invites endpoint instead.

post/teams/{key}/members

Path parameters

keystring required

Team identifier (ID or slug)

Request body

userIdstring required

User ID of the team member

roleIdsstring[] required

Role IDs assigned to this team member.

{"stackTrail":"paths:/teams/{key}/members:post:requestBody:content:application/json:schema:properties:isOwner","oasType":"schema","type":"unknown","description":"Team ownership cannot be assigned when creating a member. External clients sending isOwner: true receive an input validation error; create the non-owner member first, then migrate ownership through POST /teams/{key}/transfer with newOwnerId."}

Response

Example response

{
  "member": {
    "permissions": [
      "event.read",
      "event.write",
      "order.read"
    ]
  }
}