---
title: "Invite Channel Viewers"
method: POST
path: "/channel/{video_workspace_id}/viewers/invite"
---

# Invite Channel Viewers

`POST /channel/{video_workspace_id}/viewers/invite`

## Request

- Base URL: `https://api.gumlet.com/v1`
- URL: `https://api.gumlet.com/v1/channel/{video_workspace_id}/viewers/invite`
- Auth: API key in header `Authorization`

Invite one or more viewers to a members-only channel.

## Path parameters

- `video_workspace_id` string, required

## Request body

- object
  - `users` object[], required: List of viewers to invite. A maximum of 200 viewers can be invited in one request.
    - `email` string, email, required: Viewer email address.
    - `name` string, required: Viewer display name.

## Response `200`

200

- object
  - `success` boolean

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/gumlet/apis/gumlet-rest-apis.md) - [All operations](https://skmtc.dev/gumlet/apis/gumlet-rest-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/gumlet/apis/gumlet-rest-apis/revisions/b1f7ac2aeeec?raw)