Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
updateRequests

Create an update request

Creates an update request for the specified rows within the sheet. An email notification (containing a link to the update request) is sent to the specified recipients according to the specified schedule.

The recipients of an update request must be specified by using email addresses only. Sending an update request to a group is not supported.

The following attributes have the following values when not specified:

  • ccMe: false
  • message: Please update the following rows in my online sheet.
  • subject: Update Request: {Sheet Name}

When the Schedule object is not specified, the request is sent to the recipients immediately.

If an error occurs because the request specified one or more alternate email addresses, please retry using the primary email address.

post/sheets/{sheetId}/updaterequests

Headers

Content-Typestring

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

Request body

ccMeboolean

Indicates whether to send a copy of the email to the sender.

messagestring

The message of the email.

subjectstring

The subject of the email.

columnIdsnumber[]

The ID of the columns to be included.

includeAttachmentsboolean

Indicates whether to include attachments in the email.

includeDiscussionsboolean

Indicates whether to include discussions in the email.

layoutboolean

One of the following values: HORIZONTAL or VERTICAL. Optional, defaults to HORIZONTAL when multiple rows are being sent and to VERTICAL when a single row is being sent. HORIZONTAL formats the rows being sent as a grid, whereas VERTICAL formats the rows being sent as separate cards.

rowIdsnumber[]

The Ids of rows to be included.

idnumber

ID of the update request.

Example request

{
  "sendTo": [
    {
      "email": "john.doe@smartsheet.com"
    }
  ],
  "sentBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  }
}

Response

Result object containing the newly created UpdateRequest object.

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": {
    "sendTo": [
      {
        "email": "john.doe@smartsheet.com"
      }
    ],
    "sentBy": {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe"
    }
  }
}