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

Remove viewers from a channel

Removes viewers from a channel in the specified video workspace using their email addresses. Supply the addresses in emails; each address must use valid email format, and a request can include up to 200 addresses. The response indicates whether the removal 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.

The viewer email addresses to remove from the channel.

emailsarray<string>required

Email addresses of viewers to remove. A maximum of 200 viewers can be removed in one request.

4 status codes
200Returns a success boolean indicating whether the removal request succeeded.
successbooleanoptional
400Returned when the request is invalid, including when an email address fails validation.

One documented failure

  • invalid_channel_id

    Channel id is not a vaild id.

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, and emails must contain no more than 200 valid email addresses.