Add Group Leader
    • Dark
      Light
    • PDF

    Add Group Leader

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/groups.addLeader

    Assign the leader role to a user in a group.

    Permission required: set-leader

    Changelog

    VersionDescription
    0.58.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
    Example 1
    {
      "roomId": "ByehQjC44FwMeiLbX",
      "userId": "oCHkav5Zf6vmpu2W2"
    }
    object
    roomId
    string Required

    The groups's id

    userId
    string Required

    The user's id

    Responses
    200

    OK

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

    Bad Request

    Example 1
    {
      "success": false,
      "error": "User is already a leader [error-user-already-leader]",
      "errorType": "error-user-already-leader"
    }
    object
    success
    boolean
    error
    string
    errorType
    string

    Was this article helpful?

    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.