rows

Delete rows

Deletes one or more rows from the sheet specified in the URL.

delete/sheets/{sheetId}/rows

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: WRITE_SHEETS

Query parameters

idsstring required

A comma-separated list of row Ids.

ignoreRowsNotFoundboolean

true or false. If set to false and any of the specified row Ids are not found, no rows are deleted, and the "not found" error is returned.

Response

Returns Result object containing row Ids corresponding to all rows that were successfully deleted (including any child rows of rows specified in the URL).

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
resultnumber[]

Example response

{
  "message": "SUCCESS"
}

Changes

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