SMsmartsheet
rows

Add rows

Changed on

Inserts one or more rows into the sheet specified in the URL. If you want to insert the rows in any position but the default, use location-specifiers (that is, toTop, toBottom, parentId, siblingId, above, indent, outdent). See sample code tabs for variations in syntax.

Note: This operation does't' add rows with cells that have images. However, after the cell exists in a sheet, you can upload an image to a cell using the Add Image to Cell operation.

This operation supports both single-object and bulk semantics. For more information, refer to Optional Bulk Operations.

post/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

accessApiLevelnumber

Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.

allowPartialSuccessboolean

When specified with a value of true, enables partial success for this bulk operation. See Bulk operations > Partial success for more information.

overrideValidationboolean

You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking.

Headers

Content-Typestring

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

Request body

OR

Response

Returns Result object containing the newly created rows -- either a single Row object or array of Row objects, corresponding to what was specified in the request, as well as the new version of the sheet.

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

Example response

{
  "message": "SUCCESS"
}

Changes

  • 5fecdbbecd34Revision changes
    • info

      the request optional property /// became write-only

    • info

      the request optional property /// became write-only

    • info

      the request optional property //// became write-only

    • info

      the request optional property //// became write-only

  • 904ddd1d4169Revision changes
    • info

      added the non-success response with the status