Add Members to the Team

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/v1/teams.addMembers

Add members to a team.

Permissions required: add-team-member or edit-team-member

Header parameters

X-Auth-Token

stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

X-User-Id

stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Body parameters

Example 1

{
  "teamId": "63f3efc4b000b6b6d86704b2",
  "members": [
    {
      "userId": "rYhzFRd2QZjNwAAXX",
      "roles": [
        "member"
      ]
    }
  ]
}

Expand All

object

teamId

string Required

Enter the team ID. Alternatively, enter the teamName parameter and provide the team's name as the value.

members

Array of object Required

The users (IDs and roles) to add to the team.

object

userId

string

roles

Array of string

string

Responses

200

Success

{
  "success": true
}

object

success

boolean

Was this article helpful?

What's Next

List Team Members