SMsmartsheet
sheetSummary

Add summary fields

Creates one or more summary fields for the specified sheet.

post/sheets/{sheetId}/summary/fields

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: ADMIN_SHEETS

Query parameters

renameIfConflictboolean

Set to true if you want to override the requirement for unique summary field names. Repeated names will be adjusted by appending "(1)" or similar after the field name.

Request body

formatstring

A custom format for the summary field. In the Server info schema, refer to the defaults property as an example of specifying indexes of values to use for formatting properties, such as background color, horizontal alignment, and number formatting.

In responses, it's only returned if the include query string parameter contains "format" and this summary field has a non-default format applied to it.

formulastring

The formula for a cell, if set.

indexnumber

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

lockedboolean

Indicates whether the field is locked.

optionsstring[]

When applicable for PICKLIST column type. Array of the options available for the field.

symbolstring

When applicable for PICKLIST column type.

titlestring

Arbitrary name, must be unique within summary.

type'ABSTRACT_DATETIME' | 'CHECKBOX' | 'CONTACT_LIST' | 'DATE' | 'DATETIME' | 'DURATION' | 'MULTI_CONTACT_LIST' | 'MULTI_PICKLIST' | 'PICKLIST' | 'PREDECESSOR' | 'TEXT_NUMBER'
validationboolean

Indicates whether summary field values are restricted to the type.

Example request

[
  {
    "contactOptions": [
      {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      {
        "email": "john.doe@company.com",
        "name": "John Doe"
      }
    ],
    "objectValue": {
      "objectType": "CONTACT",
      "email": "john.doe@acme.com",
      "name": "John Doe",
      "imageId": "1234!_qwer!_5667zxcvQWER!_ASDF",
      "emailId": "23456789",
      "userId": "12345678",
      "lookUpName": true
    }
  }
]

Response

OK

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
versionnumber nullable

New version of the sheet. Applicable only for operations which update sheet data.

Example response

{
  "message": "SUCCESS",
  "result": [
    {
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "modifiedBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "objectValue": {
        "objectType": "CONTACT",
        "email": "john.doe@acme.com",
        "name": "John Doe",
        "imageId": "1234!_qwer!_5667zxcvQWER!_ASDF",
        "emailId": "23456789",
        "userId": "12345678",
        "lookUpName": true
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.