WIwistia
Folders

Create Folder

Changed on

Creates a new folder (previously called project). If the folder is created successfully the Location HTTP header will point to the new folder.

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 account authorization granting the create-folders permission can also be used. The folder's creator is the contact behind the token (the account owner for a token minted from an account-level token); adminEmail selects the folder's administrator (defaults to the account owner). personalLibrary creates the folder inside the My Library of the contact behind the token. The new folder is not covered by the token that created it, so follow-up requests need a token whose authorizations name the returned hashed id.

post/folders

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/folders
  • Auth
    HTTP bearer

Headers

X-Wistia-API-Versionstring required

Request body

namestring

The name of the folder you want to create.

adminEmailstring

The email address of the person you want to set as the owner of this folder. Defaults to the Wistia Account Owner.

descriptionstring

The folder’s description.

anonymousCanUploadboolean

Whether anonymous users can upload media to the folder.

anonymousCanDownloadboolean

Whether anonymous users can download media from the folder.

publicboolean

A flag indicating whether or not the folder is enabled for public access.

personalLibraryboolean

When true, creates the folder inside the requesting user's personal "My Library" (owned by them) instead of a shared account folder.

Example request

{
  "name": "My New Folder",
  "adminEmail": "admin@example.com",
  "description": "My New Folder Description"
}

Response

Folder created

idinteger required

A unique numeric identifier for the folder within the system.

namestring required

The folder’s display name.

descriptionstring nullable

The folder’s description.

media_countinteger required

The number of different medias that have been uploaded to the folder.

createdstring date-time required

The date that the folder was originally created.

updatedstring date-time required

The date that the folder was last updated.

hashed_idstring required

A private hashed id, uniquely identifying the folder within the system.

publicboolean required

A boolean indicating whether the folder is available for public (anonymous) viewing.

public_idstring nullable required

If the folder is public, this field contains a string representing the ID used for referencing the folder in public URLs.

anonymous_can_uploadboolean
anonymous_can_downloadboolean
kind'library' | 'shared' | 'account' required

Indicates the folder's access scope, relative to the requesting user. One of:

  • library: a library the requester owns. Libraries can still be shared with specific contacts or contact groups; the only restriction is that they cannot be shared with the whole account.
  • shared: a folder the requester has access to via a Contact or ContactGroup sharing — this includes both shared folders and another contact's library that the requester has been granted access to.
  • account: a folder shared with the whole account (everyone in the company can see it).
personal_libraryboolean required

Whether this folder is someone's personal library ("My Library"). Unlike kind, this is a property of the folder itself and does not depend on who is requesting — it is true for a personal library even when that library has been shared with you (where kind would read shared). Use this, not kind, to tell whether a folder is a personal library.

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": 22570,
  "name": "My Folder Title",
  "description": "About My Folder",
  "media_count": 2,
  "created": "2010-08-13T18:47:39+00:00",
  "updated": "2010-08-19T21:47:00+00:00",
  "hashed_id": "4d23503f70",
  "public_id": "4bD",
  "kind": "shared"
}

Changes