Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
updateRequests

Get an update request

Gets the specified update request for the sheet that has a future schedule.

The rowIds and columnIds in the returned UpdateRequest object represent the list at the time the update request was created or last modified. The lists may contain Ids of rows or columns that are no longer valid (for example, they have been removed from the sheet).

get/sheets/{sheetId}/updaterequests/{updateRequestId}

Response

UpdateRequest object

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 response

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