Login
    Contents x
    Join External Public Room
      • Print
      • Dark
        Light
      • PDF
      Contents

      Join External Public Room

        • Print
        • Dark
          Light
        • PDF
        Article summary

        Post
        /api/v1/federation/joinExternalPublicRoom
        Premium tag

        Changelog

        VersionDescription
        6.0.0Added
        Header parameters
        X-User-Id
        stringRequired

        The user ID.

        ExampleCkCPNctrgCDfmWLqC
        X-Auth-Token
        stringRequired

        The authentication token.

        Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
        Body parameters
        Example 1
        {
  "externalRoomId": "!externalRoomId:server.com"
}
        object
        externalRoomId
        string Required

        The external public room ID.

        Example!externalRoomId:server.com
        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

        Tags

        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        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.
        Logout