WIwistia
Channel Collaborators

Create Channel Collaborator

Changed on

Invites a collaborator to a channel by specifying their email address and role. Creates a new contact if one doesn't exist with that email.

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the update permission on this channel can also be used.

post/channels/{channelHashedId}/collaborators

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/channels/{channelHashedId}/collaborators
  • Auth
    HTTP bearer

Path parameters

channelHashedIdstring required

Hashed ID of the channel (e.g., "abc123")

Hashed ID of the channel

Headers

X-Wistia-API-Versionstring required

Request body

emailstring email required

Email address of the contact to invite. Creates a new contact if one doesn't exist.

role'admin' | 'viewer' required

The role to grant the collaborator.

Example request

{
  "email": "jim@wistia.com",
  "role": "admin"
}

Response

Channel collaborator created successfully

idinteger required

The unique identifier of the channel role.

role'admin' | 'viewer' required

The role of the collaborator on the channel.

created_atstring date-time required

The timestamp when this collaborator was added.

cursorstring nullable

A cursor for stable pagination based on current sort_by order. You can pass this to cursor[before] or cursor[after] as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with cursor[enabled], or cursor[before] or cursor[after].

Example response

{
  "id": 14,
  "role": "admin",
  "created_at": "2024-01-15T10:30:00Z",
  "share": {
    "id": 3,
    "name": "Jim",
    "type": "Contact",
    "email": "jim@wistia.com"
  }
}

Changes