v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
sheets

Create sheet in folder

Creates a sheet from scratch or from the specified template in the specified folder.

post/folders/{folderId}/sheets

Query parameters

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

Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template.

Headers

Content-Typestring

Required for POST and PUT requests. Defines the structure for the request body.

Request body

OR

Example request

{
  "columns": [
    {
      "id": 4567890123,
      "width": 150,
      "autoNumberFormat": {
        "fill": "",
        "prefix": "",
        "startingNumber": 1,
        "suffix": ""
      }
    }
  ]
}

Response

Result object containing a Sheet object for newly created sheet, corresponding to what was specified in the request.

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation

Example response

{
  "message": "SUCCESS",
  "result": {
    "columns": [
      {
        "id": 4567890123,
        "width": 150,
        "tags": []
      }
    ]
  }
}