Leave a Team

Leave a Team

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/v1/teams.leave

Leave a team

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

{
  "teamName": "team1",
  "rooms": [
    "8dugqGhuRvCBLdZft"
  ]
}

object

teamId

string Required

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

rooms

Array of string Required

The team room IDs to remove the user from.

string

Responses

200

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?