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.
Request
- Base URLhttps://api.smartsheet.com/2.0
- Auth
- HTTP bearer
- or OAuth 2Authorization code: https://app.smartsheet.com/b/authorizeToken URL: https://api.smartsheet.com/2.0/token scopes: WRITE_SHEETS
Headers
Required for POST and PUT requests. Defines the structure for the request body.
Request body
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.
Example response
{
"message": "SUCCESS",
"result": {
"sendTo": [
{
"email": "john.doe@smartsheet.com"
}
],
"sentBy": {
"email": "jane.doe@smartsheet.com",
"name": "Jane Doe"
}
}
}Changes
No recorded changes to this operation across all 16 revisions of this API.