Add Rooms to a Team
    • Dark
      Light
    • PDF

    Add Rooms to a Team

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/teams.addRooms

    Adds rooms to the team.

    Permission required: add-team-channel

    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
    {
      "teamId": "607e0d9b49d493189836bfac",
      "rooms": [
        "8Z7eRsibvD5AANfmK"
      ]
    }
    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 IDs of the rooms to be added to the team.

    string
    Responses
    200

    OK

    Example 1
    {
      "rooms": [
        {
          "_id": "JKa7R9zu2DinBhBN9",
          "fname": "Livestream",
          "customFields": {},
          "description": "",
          "broadcast": false,
          "encrypted": false,
          "federated": false,
          "name": "Livestream",
          "t": "c",
          "msgs": 15,
          "usersCount": 3,
          "u": {
            "_id": "rbAXPnMktTFbNpwtJ",
            "username": "roxie"
          },
          "ts": "2023-02-22T17:15:26.989Z",
          "ro": false,
          "default": false,
          "sysMes": true,
          "_updatedAt": "2023-09-26T01:05:39.641Z",
          "lm": "2023-09-14T12:06:00.594Z",
          "lastMessage": {
            "_id": "rtf5JoPLQup3X7Aof",
            "t": "videoconf",
            "msg": "",
            "groupable": false,
            "blocks": [
              {
                "type": "video_conf",
                "blockId": "6502f728a2f73c7460df6f71",
                "callId": "6502f728a2f73c7460df6f71",
                "appId": "videoconf-core"
              }
            ],
            "ts": "2023-09-14T12:06:00.594Z",
            "u": {
              "_id": "rbAXPnMktTFbNpwtJ",
              "username": "test.test",
              "name": "test test"
            },
            "rid": "JKa7R9zu2DinBhBN9",
            "_updatedAt": "2023-09-14T12:06:00.685Z",
            "urls": [],
            "mentions": [],
            "channels": []
          },
          "teamId": "63f3efc4b000b6b6d86704b2"
        }
      ],
      "success": true
    }
    Expand All
    object
    rooms
    Array of object
    object
    _id
    string
    fname
    string
    customFields
    object
    description
    string
    broadcast
    boolean
    encrypted
    boolean
    federated
    boolean
    name
    string
    t
    string
    msgs
    integer
    usersCount
    integer
    u
    object
    _id
    string
    username
    string
    ts
    string
    ro
    boolean
    default
    boolean
    sysMes
    boolean
    _updatedAt
    string
    lm
    string
    lastMessage
    object
    _id
    string
    t
    string
    msg
    string
    groupable
    boolean
    blocks
    Array of object
    object
    type
    string
    blockId
    string
    callId
    string
    appId
    string
    ts
    string
    u
    object
    _id
    string
    username
    string
    name
    string
    rid
    string
    _updatedAt
    string
    urls
    Array of object
    object
    mentions
    Array of object
    object
    channels
    Array of object
    object
    teamId
    string
    success
    boolean

    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.