OCT-103 Gumlet outreach
POST/channel/{video_workspace_id}/viewers/invite

Invite viewers to a channel

Invites viewers to a members-only channel in the specified video workspace. Provide each viewer's email and name; each request can include up to 200 viewers. The response indicates whether the invitation request succeeded.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
video_workspace_idstringrequired

The identifier of the video workspace containing the channel.

Viewer invitation details. The users array must contain between 1 and 200 viewers.

usersarray<object>required

List of viewers to invite. A maximum of 200 viewers can be invited in one request.

4 status codes
200Returns a success boolean indicating whether the invitation request succeeded.
successbooleanoptional
400Returned when the request is invalid, including when viewer details fail validation.

One documented failure

  • invalid_email_format

    One of the emails provided is in invalid format, Please provide a valid email address.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned for an unpaid account or insufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the API key or bearer token is missing or invalid. A 403 is returned for an unpaid account or insufficient role permissions. The video_workspace_id path parameter identifies the workspace; users must contain 1 to 200 entries, each with a valid email address and a name of 1 to 100 characters.