WIwistia
Folders

Copy Folder

Changed on

This copies a folder (previously called project) and all its media and subfolders asynchronously in a background job.

This method does not copy the folder’s sharing information (i.e. users that could see the old folder will not automatically be able to see the new one).

For the request you can specify the owner of a new folder by passing an optional parameter. The person you specify must be a Manager in the account.

The body of the response will contain an object representing the background job that was created.

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.

post/folders/{id}/copy

Request

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

Path parameters

idstring required

Hashed ID of the folder (e.g., "4d23503f70")

Folder Hashed ID

Headers

X-Wistia-API-Versionstring required

Request body

adminEmailstring

The email address of the account Manager that will be the owner of the new folder. Defaults to the Account Owner if invalid or omitted.

Example request

{
  "adminEmail": "admin@example.com"
}

Response

Folder queued to be copied

idinteger required

The ID of the background job that's been queued for the request.

hashed_idstring required

The unguessable hashed ID of the background job. Prefer this over the numeric ID when polling for status.

status'queued' | 'started' | 'finished' | 'failed' required

The status of the background job that's been queued for the request.

Changes