Add CheckBox Field
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/fields/checkbox |
||
HTTP Verb |
POST |
|
Authorization |
Bearer {access_token} |
|
Content-Type |
application/json |
|
Accept |
application/json |
|
Response Headers |
||
Request Body |
{ "order" : 1, "page_no" : 1, "value" : "" , "validation_rule" : "MANDATORY" , "dimensions" : { "x" : 200, "y" : 200 } }
|
|
Status Code |
Message |
Response Body |
200 |
OK |
{ "field_name" : "Checkbox 1" } |
403 | Forbidden |
{ "Message" : "You are not allowed to perform this action on locked workflow" } |
{ "Message" : "Account is disabled" } |
||
{ "Message" : "You are not allowed to perform the requested operation" } |
||
{ "Message" : "You cannot add fields once the document has been signed" } |
||
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 the "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. |
package_id | Package ID to which the document is added. |
document_id | The document ID for which the action is to be taken. |
order |
The order of the user in workflow for which the field is being added. |
page_no | Page number on which the field is to be created. |
field_name (optional) | Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
value | Value of the field. Possible values are "true" or "false" |
validation_rule | One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL". |
dimensions > x | Left location of the field in pixel. |
dimensions > y | Top location of the field in pixel. |
Response Parameters: | |
field_name | Name of the field created in the document. |
Message | The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |