PUT
/
envelope
/
{envelope_id}
/
set_comment
curl --request PUT \
  --url https://restapi.sign.plus/v2/envelope/{envelope_id}/set_comment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "comment": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "comment": "<string>",
  "pages": 123,
  "flow_type": "REQUEST_SIGNATURE",
  "legality_level": "SES",
  "status": "DRAFT",
  "created_at": 123,
  "updated_at": 123,
  "expires_at": 123,
  "num_recipients": 123,
  "is_duplicable": true,
  "signing_steps": [
    {
      "recipients": [
        {
          "id": "<string>",
          "uid": "<string>",
          "name": "<string>",
          "email": "<string>",
          "role": "SIGNER",
          "verification": {
            "type": "SMS",
            "value": "<string>"
          }
        }
      ]
    }
  ],
  "documents": [
    {
      "id": "<string>",
      "name": "<string>",
      "filename": "<string>",
      "page_count": 123,
      "pages": [
        {
          "width": 123,
          "height": 123
        }
      ]
    }
  ],
  "notification": {
    "subject": "<string>",
    "message": "<string>",
    "reminder_interval": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelope_id
string
required

Body

application/json

Response

200 - application/json
Envelope comment changed successfully

The response is of type object.