Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
imports

Import sheet from CSV / XLSX

Imports CSV or XLSX data into a new sheet in the top-level "Sheets" folder.

Note the following:

  • Both sheetName and the file name must use ASCII characters.

  • The source data must be basic text. To include rich formula data, import and create a sheet first, and then use Update Rows. To work with images, see Cell Images.

  • XLS is not supported. You must use XLSX.

  • Hierarchical relationships between rows in an external file won't import.

DEPRECATED - The Sheets folder is being replaced by workspaces. To adapt to this change, please see Migrate from using the Sheets folder.

post/sheets/import

Query parameters

sheetNamestring required

Desired name of the sheet.

headerRowIndexnumber

A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc.

primaryColumnIndexnumber

A zero-based integer indicating the column to designate as primary.

Headers

Content-Dispositionstring
Example:attachment; filename="ProgressReport.docx"

Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes

Content-Type'text/csv' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' required

Required for POST request to import a sheet from CSV/XLSX file.

  • For CSV files, use: Content-Type: text/csv
  • For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Response

Result object containing a Sheet object for imported sheet.

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"
}