Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
folders

Copy folder

Copies a folder.

Important: This operation doesn't copy cell history.

post/folders/{folderId}/copy

Query parameters

include'attachments' | 'cellLinks' | 'data' | 'discussions' | 'filters' | 'forms' | 'ruleRecipients' | 'rules' | 'shares'

A comma-separated list of elements to copy:

  • "attachments"
  • "cellLinks" - includes cross-sheet references
  • "data" - includes formatting
  • "discussions" - includes comments
  • "filters"
  • "forms"
  • "ruleRecipients" -- includes notification recipients, must also include rules when using this attribute
  • "rules" -- includes notifications and workflow rules
  • "shares"

Important: This operation doesn't copy cell history.

exclude'sheetHyperlinks'

When specified with a value of sheetHyperlinks, excludes this category from the response

skipRemap'cellLinks' | 'reports' | 'sheetHyperlinks' | 'sights'

A comma-separated list of references to NOT re-map for the newly created folder.

Headers

Content-Type'application/json' required

Defines the structure for the request body.

Request body

OR

Example request

{
  "newName": "newFolderName",
  "destinationId": 7960873114331022
}

Response

Basic information about the new Folder

message'SUCCESS'

Message that indicates the request was successful.

resultCode0
  • '0' Success

Example response

{
  "message": "SUCCESS"
}