Remove Member from Team
    • Dark
      Light
    • PDF

    Remove Member from Team

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/teams.removeMember

    Removes a member from a team.

    Permission required: 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
    {
      "teamId": "63f3efc4b000b6b6d86704b2",
      "userId": "rYhzFRd2QZjNwAAXX",
      "rooms": [
        "JKa7R9zu2DinBhBN9"
      ]
    }
    object
    teamId
    string Required

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

    userId
    string Required

    The user ID to remove from the team.

    rooms
    Array of string

    The rooms (IDs) from which the user should be removed.

    string
    Responses
    200

    OK

    Success
    {
      "success": true
    }
    object
    success
    boolean
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.