> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Share Video Conference Chat

> Gives the conference members who cannot read the call chat access to it, and returns the ID of the room that holds the chat afterwards. If every member already has access, the current chat room ID is returned and nothing changes. When the selected `mode` is not allowed, the request fails with `error-not-allowed`.

You must be a member of the conference or have access to the conference's room or discussion. Requests are limited to 5 per minute per client IP address.

### Changelog
| Version | Description |
| ------- | ----------- |
| 8.9.0   | Added       |

## OpenAPI

````json POST /api/v1/video-conference.share-chat
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Settings"
  },
  "servers": [
    {
      "url": "https://apiexplorer.support.rocket.chat"
    }
  ],
  "tags": [
    {
      "name": "Settings"
    },
    {
      "name": "Audit"
    },
    {
      "name": "Cloud"
    },
    {
      "name": "DNS"
    },
    {
      "name": "E2E"
    },
    {
      "name": "Import"
    },
    {
      "name": "Bulk User Import"
    },
    {
      "name": "Instances"
    },
    {
      "name": "Federation"
    },
    {
      "name": "Moderation"
    },
    {
      "name": "Device Management"
    },
    {
      "name": "Password policy"
    },
    {
      "name": "Video Conference"
    },
    {
      "name": "Media Calls"
    }
  ],
  "paths": {
    "/api/v1/video-conference.share-chat": {
      "post": {
        "tags": [
          "Video Conference"
        ],
        "summary": "Share Video Conference Chat",
        "description": "Gives the conference members who cannot read the call chat access to it, and returns the ID of the room that holds the chat afterwards. If every member already has access, the current chat room ID is returned and nothing changes. When the selected `mode` is not allowed, the request fails with `error-not-allowed`.\n\nYou must be a member of the conference or have access to the conference's room or discussion. Requests are limited to 5 per minute per client IP address.\n\n### Changelog\n| Version | Description |\n| ------- | ----------- |\n| 8.9.0   | Added       |",
        "operationId": "post-api-v1-video-conference.share-chat",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-User-Id"
          },
          {
            "$ref": "#/components/parameters/X-Auth-Token"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "callId",
                  "mode"
                ],
                "additionalProperties": false,
                "properties": {
                  "callId": {
                    "type": "string",
                    "description": "The video conference call ID.",
                    "example": "697887e3c8b0533020781a4a"
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "invite",
                      "discussion"
                    ],
                    "description": "How to give members access to the call chat:\n* `invite`: Add the members without access to the room that holds the chat. Not available for rooms that cannot take new members, such as direct messages.\n* `discussion`: Move the chat to a new discussion that includes the conference members. Requires discussions to be enabled and the `start-discussion` or `start-discussion-other-user` permission.",
                    "example": "discussion"
                  }
                }
              },
              "examples": {
                "Example": {
                  "value": {
                    "callId": "697887e3c8b0533020781a4a",
                    "mode": "discussion"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "rid": {
                      "type": "string",
                      "description": "The ID of the room that holds the call chat."
                    },
                    "success": {
                      "type": "boolean"
                    }
                  }
                },
                "examples": {
                  "Success Example": {
                    "value": {
                      "rid": "7Tb3XkPq9WmRzL2cN",
                      "success": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorType": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "Missing Parameter": {
                    "value": {
                      "success": false,
                      "error": "must have required property 'callId' [invalid-params]",
                      "errorType": "invalid-params"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authorizationError"
          },
          "404": {
            "description": "Not Found. The call does not exist, or you are neither a member of the conference nor able to access its room.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "Not Found": {
                    "value": {
                      "success": false,
                      "error": "Resource not found"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "X-User-Id": {
        "name": "X-User-Id",
        "in": "header",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "CkCPNctrgCDfmWLqC",
        "description": "The user ID."
      },
      "X-Auth-Token": {
        "name": "X-Auth-Token",
        "in": "header",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE",
        "description": "The authentication token."
      }
    },
    "responses": {
      "authorizationError": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                }
              }
            },
            "examples": {
              "Authorization Error": {
                "value": {
                  "status": "error",
                  "message": "You must be logged in to do this."
                }
              }
            }
          }
        }
      }
    }
  }
}
````