SMsmartsheet
sheetSummary

Add image to sheet summary

Adds an image to the summary field.

post/sheets/{sheetId}/summary/fields/{fieldId}/images

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

altTextstring

Url-encoded alternate text for the image

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.

Content-Dispositionstring
Example:attachment; filename="ProgressReport.docx"

Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes

Content-Lengthinteger
Example:5463

Must be set to the size of the file, in bytes. For example to determine file size using in UNIX:

$ ls -l ProgressReport.docx

5463 ProgressReport.docx

Request body application/octet-stream

string binary required

Response

SUCCESS

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",
  "result": {
    "objectValue": {
      "objectType": "CONTACT",
      "email": "john.doe@acme.com",
      "name": "John Doe",
      "imageId": "1234!_qwer!_5667zxcvQWER!_ASDF",
      "emailId": "23456789",
      "userId": "12345678",
      "lookUpName": true
    }
  }
}

Changes

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