Skip to main content
PATCH
Update a file

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The file or folder ID.

Minimum string length: 1

Body

application/json
name
string

A new name.

Required string length: 1 - 255
folderId
string | null

Move it into this folder in the same location, or null to move it to the top level.

Minimum string length: 1

Response

OK

A file or a folder, told apart by type.

type
any
required
id
string
required

The file or folder ID.

Minimum string length: 1
name
string
required

The name, including any file extension.

location
object
required

Whose files these are: a project's, an account's, a contact's, or an intake's, or the organization's Library.

folder
object | null
required

The folder it is in, or null at the top level.

createdAt
string<date-time>
required

When it was added.

updatedAt
string<date-time>
required

When it was last updated, including processing, renames, and moves.

mediaType
string | null
required

The file's media type, such as application/pdf, from its extension, or null when the extension isn't recognized.

status
enum<string>
required

Whether Parley has extracted the file's text: pending (queued), processing, ready (its text can be read), or failed (download it instead).

Available options:
pending,
processing,
ready,
failed