Leave Group
    • Dark
      Light
    • PDF

    Leave Group

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/groups.leave

    Causes the request sender to be removed from the group/channel if they're part of it and are not the last owner.

    Changelog

    VersionDescription
    0.48.0Added
    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
    object
    roomId
    string

    The group ID that you want to leave.

    ExampleByehQjC44FwMeiLbX
    Responses
    200

    OK

    Example 1
    {
      "group": {
        "_id": "ByehQjC44FwMeiLbX",
        "name": "invite-me",
        "t": "p",
        "usernames": [
          "testing2"
        ],
        "msgs": 0,
        "u": {
          "_id": "aobEdbYhXfu5hkeqG",
          "username": "testing1"
        },
        "ts": "2016-12-09T15:08:58.042Z",
        "ro": false,
        "sysMes": true,
        "_updatedAt": "2016-12-09T15:22:40.656Z"
      },
      "success": true
    }
    Expand All
    object
    group
    object
    _id
    string
    name
    string
    t
    string
    usernames
    Array of string
    string
    msgs
    integer
    u
    object
    _id
    string
    username
    string
    ts
    string
    ro
    boolean
    sysMes
    boolean
    _updatedAt
    string
    success
    boolean

    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.