Update Certify Policy for a document
|
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/certify |
||
|
HTTP Verb |
PUT |
|
|
Authorization |
Bearer {access_token} |
|
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
|
Response Headers |
||
|
Request Body |
{ "certify": { "enabled": true, "permission": "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED" }, "lock_form_fields": false}
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
|
| 403 | Forbidden |
{ "Message": "You are not allowed to set both certify policy and locking in workflow only me"} |
{ "Message": "You are not allowed to perform this action on locked workflow"} |
||
{ "Message": "Account is disabled"} |
||
| 500 | Internal Server Error |
{ "Message": "An internal server error occurred while processing the request"} |
| Item Details | |
| Names |
Description |
| Request Parameters |
|
| access_token | The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges. |
| document_id |
The ID of the document on which the action is to be performed. |
| package_id | Package ID of the package to which the document is added. |
| certify | Certify settings object for the document. |
| certify > enabled | True if certify settings are to be enabled for the document. |
| certify > permission | Certify permission level that is to be set for the document. Possible values are "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" and "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED". |
| lock_form_fields | True if form fields are to be locked after the last signature on the current document. |
| Response Parameters | |
| Message |
The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |