WIwistia
Webinars

Update Webinar

Changed on

Updates an existing webinar.

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 webinar can also be used. The update permission also allows registering attendees and managing the webinar's collaborators.

put/webinars/{id}

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/webinars/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The hashed ID of the webinar

Headers

X-Wistia-API-Versionstring required

Request body

Example request

{
  "webinar": {
    "title": "Updated Webinar Title",
    "description": "Updated webinar description",
    "scheduled_for": "2024-03-20T15:30:00Z",
    "event_duration": 90,
    "time_zone": "America/New_York",
    "folder_id": "abc123def456"
  }
}

Response

Webinar updated successfully

idstring required

The hashed ID of the webinar

hashed_idstring required

The hashed ID of the webinar. Identical to id, named to match every other Wistia resource.

titlestring required

The title of the webinar

descriptionstring nullable

The description of the webinar

scheduled_forstring date-time nullable

The scheduled start time in W3C format with timezone

event_durationinteger nullable

Duration of the webinar in minutes

time_zonestring required

The IANA time zone identifier the webinar is scheduled in

lifecycle_status'pending' | 'ready' | 'starting' | 'started' | 'ended' | 'vod_ready' | 'failed' required

The current lifecycle status of the webinar. This is a read-only, system-managed field that Wistia updates as the event moves through its lifecycle; it cannot be set or changed via the API.

registration_statusstring required

Registration status of the event

created_atstring date-time required

When the event was created (UTC)

updated_atstring date-time required

When the event was last updated (UTC)

audience_linkstring required

Link for the audience to join the event

host_linkstring required

Link for the host to manage the event

panelist_linkstring required

Link for panelists to join the event

thumbnail_urlstring nullable

URL of the webinar's custom thumbnail image, or null if no custom thumbnail has been set

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": "abc123def456",
  "hashed_id": "abc123def456",
  "title": "Wellness Session: Coping with Outie Memories",
  "description": "A comprehensive session on managing work-life balance",
  "scheduled_for": "2024-03-20T15:30:00-05:00",
  "event_duration": 60,
  "time_zone": "America/New_York",
  "lifecycle_status": "ready",
  "registration_status": "published",
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-15T10:30:00Z",
  "audience_link": "https://lumon-industries.wistia.com/live/events/abc123def456",
  "host_link": "https://lumon-industries.wistia.com/live/events/abc123def456/onair",
  "panelist_link": "https://lumon-industries.wistia.com/live/events/abc123def456/onair/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "thumbnail_url": "https://embed-ssl.wistia.com/deliveries/abc123def456.jpg"
}

Changes