WIwistia
Subfolders

Update Subfolder

Changed on

Updates a subfolder's name and/or description.

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 folder can also be used.

put/folders/{folderId}/subfolders/{subfolderId}

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/folders/{folderId}/subfolders/{subfolderId}
  • Auth
    HTTP bearer

Path parameters

folderIdstring required
Example:abc123def4

The hashed ID of the folder

subfolderIdstring required
Example:xyz789ghi0

The hashed ID of the subfolder

Headers

X-Wistia-API-Versionstring required

Request body

namestring

The new name for the subfolder

descriptionstring nullable

The new description for the subfolder

Example request

{
  "name": "Updated Marketing Videos",
  "description": "Updated collection of marketing materials"
}

Response

Subfolder updated successfully

hashed_idstring nullable required

A unique alphanumeric identifier for this subfolder.

namestring nullable

The display name of the subfolder.

descriptionstring nullable

A description for the subfolder.

positioninteger nullable required

The position of this subfolder within its folder, used for ordering.

createdstring date-time nullable required

The date when the subfolder was created.

updatedstring date-time nullable required

The date when the subfolder was last modified.

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

{
  "hashed_id": "abc123def4",
  "name": "Marketing Videos",
  "description": "Collection of all marketing and promotional videos",
  "position": 1,
  "created": "2024-01-15T10:30:00+00:00",
  "updated": "2024-01-20T14:45:00+00:00"
}

Changes