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

Invite channel viewers using a CSV file

Invites viewers to a channel by uploading a CSV file for the specified video workspace. Send the file in the viewers_csv field with email and name columns; the file can contain up to 500 viewers. Use this operation when you want to submit viewer invitations in bulk from a CSV.

  • 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.

Multipart form data containing a CSV file of viewers to invite.

viewers_csvstringrequired

CSV file containing viewer rows. Required columns: email, name. Maximum 500 viewers.

5 status codes
200Returns a success boolean indicating whether the invitation request succeeded.
successbooleanoptional
400Returned when the request is invalid, including when the CSV does not meet the required format.

One documented failure

  • csv_file_missing

    CSV File is a required parameters

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
413Returned when the uploaded payload is too large.

One documented failure

  • file_too_large

    Uploaded file exceeds the maximum allowed size

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. A 413 is returned when the uploaded payload is too large. The video_workspace_id path parameter identifies the workspace, and the CSV must include email and name columns and contain no more than 500 viewers.