Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-2118931.2 KB
Files

Updates an existing folder

By passing in the appropriate ID and properties, you can update a folder

put/Folders/{FolderId}

Path parameters

FolderIdstring uuid required
Example:4ff1e5cc-9835-40d5-bb18-09fdb118db9c

Folder id for single object

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

Namestring

The name of the folder

FileCountinteger

The number of files in the folder

Emailstring

The email address used to email files to the inbox. Only the inbox will have this element.

IsInboxboolean

to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.

Idstring uuid

Xero unique identifier for a folder Files

Example request

{
  "Name": "assets",
  "FileCount": 5,
  "Email": "foo@bar.com",
  "IsInbox": true,
  "Id": "4ff1e5cc-9835-40d5-bb18-09fdb118db9c"
}

Response

return the updated object

Namestring

The name of the folder

FileCountinteger

The number of files in the folder

Emailstring

The email address used to email files to the inbox. Only the inbox will have this element.

IsInboxboolean

to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.

Idstring uuid

Xero unique identifier for a folder Files

Example response

{
  "Name": "assets",
  "FileCount": 5,
  "Email": "foo@bar.com",
  "IsInbox": true,
  "Id": "4ff1e5cc-9835-40d5-bb18-09fdb118db9c"
}