Fill Form Fields
|
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/fields |
||
|
HTTP Verb |
PUT |
|
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
|
Authorization |
Bearer {access_token} |
|
|
Request Body |
{
"auto_save": false, "text": [ { "field_name": "SH_Company", "value": "" } ], "radio": [ { "field_name": "SH_Company", "value": true, "radio_group_name": "radio button group name" } ], "checkbox": [ { "field_name": "SH_Company", "value": true } ], "dropdown": [ { "field_name": "SH_Company", "value": "" } ], "listbox": [ { "field_name": "SH_Company", "value": "" } ]}
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
|
|
401 |
Unauthorized |
{ "Message": "Request authorization denied"} |
{ "Message": "User authentication required"} |
||
|
403 |
Forbidden |
{ "Message": "Document does not belong to user"} |
{ "Message": "You cannot access this document after the access period ends"} |
||
{ "Message": "Account is disabled"} |
||
|
404 |
Not Found |
{ "Message": "Document not found"} |
|
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. |
| package_id | Package ID to which the document is added. |
| auto_save (optional) |
Default value is false. True, if the form fields are being saved without user intervention e.g., while closing the document or pressing back. For Signing, Initials, In-persons, Reviewing, Submit actions the value is false. |
| text > field_name |
Unique identifier of the field in the document. |
| text > value | Value of the field to be saved in the document. |
| radio > field_name | Unique identifier of the field in the document. |
| radio > radio_group_name | Group name to which the radio button belongs. |
| radio > value | Value of the field to be saved in the document. |
| checkbox > field_name | Unique identifier of the field in the document. |
| checkbox > value | Value of the field to be saved in the document. |
| dropdown > field_name | Unique identifier of the field in the document. |
| dropdown > value | Value of the field to be saved in the document. |
| listbox > field_name | Unique identifier of the field in the document. |
| listbox > value | Value of the field to be saved in the 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. |