v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
users

Update user profile image

Uploads an image to the user profile.

Uploading a profile image differs from Adding an Image to a Cell in the following ways:

  • A Content-Length header is not required
  • Allowable file types are limited to: gif, jpg, and png
  • Maximum file size is determined by the following rules:
    • If you have not defined a custom size and the image is larger than 1050 x 1050 pixels, Smartsheet scales the image down to 1050 x 1050
    • If you have defined a custom size, Smartsheet uses that as the file size max
  • If the image is not square, Smartsheet uses a solid color to pad the image
post/users/{userId}/profileimage

Headers

Content-Typestring

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

Request body

attachmentSubType'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET'

Attachment sub type.

Note: "FOLDER" type is for EGNYTE values--the rest are GOOGLE_DRIVE values.

attachmentType'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO'

Attachment type.

Note: "DROPBOX", "EGNYTE", and "EVERNOTE" aren't supported for Smartsheet.gov accounts.

descriptionstring
namestring
urlstring

Response

Returns the result 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

Example response

{
  "message": "SUCCESS",
  "data": [
    {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe",
      "firstName": "Jane",
      "lastName": "Doe",
      "profileImage": {
        "imageId": "u!1!nAtdn5RJB_o!k6_e_3h2R3w!wmYXPek-yVD",
        "height": 1050,
        "width": 1050
      },
      "id": 48569348493401200
    }
  ]
}