proofs

Create proof request

Creates a proof request.

post/sheets/{sheetId}/proofs/{proofId}/requests

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

Headers

Content-Typestring

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

Request body

ccMeboolean

Indicates whether to send a copy of the email to the sender.

messagestring

The message of the email.

subjectstring

The subject of the email.

Example request

{
  "sendTo": [
    {
      "email": "john.doe@smartsheet.com"
    }
  ]
}

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": {
    "sendTo": [
      {
        "email": "john.doe@smartsheet.com"
      }
    ]
  }
}

Changes

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