POST /sheets/{sheetId}/columns

Inserts one or more columns into the sheet specified in the URL.This operation can be performed using a simple upload or a multipart upload. For more information, see Post an Attachment.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
formula String No

The formula for a column, if set, for instance =data@row.

description String No

Column description.

width Number No

Display width of the column in pixels.

locked Boolean No

Indicates whether the column is locked. In a response, a value of true indicates that the column has been locked by the sheet owner or the admin.

validation Boolean No

Indicates whether validation has been enabled for the column (value = true)

lockedForUser Boolean No

Indicates whether the column is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request.

contactOptions No
hidden Boolean No

Indicates whether the column is hidden.

systemColumnType String No

See System Columns

Possible values:

  • "MODIFIED_BY"
  • "CREATED_BY"
  • "MODIFIED_DATE"
  • "CREATED_DATE"
  • "AUTO_NUMBER"
format String No

The format descriptor (see Formatting). Only returned if the include query string parameter contains format and this column has a non-default format applied to it.

symbol String No

When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns.

options[] Array No
version Number No

Read only. The level of the column type. Each element in the array is set to one of the following values:

  • 0: TEXT_NUMBER, CONTACT_LIST, or PICKLIST
  • 1: MULTI_CONTACT_LIST
  • 2: MULTI_PICKLIST

See Versioning and Changes.

title String No

Column title.

type String No

Possible values:

  • "CONTACT_LIST"
  • "DURATION"
  • "ABSTRACT_DATETIME"
  • "DATE"
  • "DATETIME"
  • "PREDECESSOR"
  • "PICKLIST"
  • "MULTI_CONTACT_LIST"
  • "MULTI_PICKLIST"
  • "CHECKBOX"
  • "TEXT_NUMBER"
index Number No

Column index or position. This number is zero-based.

autoNumberFormat No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.