Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
proofs

Update proof status

Sets the proof status as either complete or incomplete.

put/sheets/{sheetId}/proofs/{proofId}

Request body

isCompletedboolean

Response

SUCCESS

idnumber

Proof ID of the proof version.

originalIdnumber

Proof ID of the original proof version.

namestring

Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.

type'DOCUMENT' | 'IMAGE' | 'MIXED' | 'NONE' | 'VIDEO'

File type for the proof version.

documentTypestring

If type=DOCUMENT, then this indicates the type of file, such as PDF.

proofRequestUrlstring

URL to review a proofing request.

versionnumber

The version number of the proof.

isCompletedboolean

Indicates whether the proof is completed.

Example response

{
  "lastUpdatedBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  },
  "attachments": [
    {
      "mimeType": "PNG",
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      }
    }
  ],
  "discussions": [
    {
      "comments": [
        {
          "attachments": [
            {
              "mimeType": "PNG",
              "createdBy": {
                "email": "jane.doe@smartsheet.com",
                "name": "Jane Doe"
              }
            }
          ],
          "createdBy": {
            "email": "jane.doe@smartsheet.com",
            "name": "Jane Doe"
          }
        }
      ],
      "commentAttachments": [
        {
          "mimeType": "PNG",
          "createdBy": {
            "email": "jane.doe@smartsheet.com",
            "name": "Jane Doe"
          }
        }
      ],
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "lastCommentedUser": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      }
    }
  ]
}