v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

updateRequests

Update an update request

Changes the specified update request for the sheet.

Making changes to update requests that do not have future scheduled delivery is not allowed.

The UpdateRequest object in the request body must specify one or more of the following attributes:

ccMe: Boolean
columnIds: number[]
includeAttachments: Boolean
includeDiscussions: Boolean
message: string
schedule: Schedule object
sendTo: Recipient[]
subject: string

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

put/sheets/{sheetId}/updaterequests/{updateRequestId}

Headers

Content-Typestring

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

Response

Result object containing the modified 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"
    }
  }
}