Update In-person Field - SigningHub-APIGuide

Business applications can use this service API to update an in-person signature field of a document in a package.

Note all of the input parameters can be changed. Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields. The latter can be used when a template was applied or the document was created using the GUI interface.

https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/fields/in_person_signature
HTTP Verb		PUT
Authorization		Bearer {access_token}
Content-Type		application/json
Accept		application/json
Response Headers
Request Body		`{` `"field_name":` `"field_name", "renamed_as": "Updated field_name",` `"page_no": 1,` `"placeholder":` `"", "display": "INVISIBLE",` `"dimensions": {` `"x": 200,` `"y": 200,` `"width": 100,` `"height": 100` `},` `"authentication": {` `"enabled":` `true,` `"sms_otp": {` `"enabled":` `false,` `"mobile_number":` `"00445566778899"` `}` `}` `}`
Status Code	Message	Response Body
200	OK
403	Forbidden	`{` `"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"` `}`

The detail of each item provided in the request and response is provided below:

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.
field_name	Current name of the field, that is to be updated.
renamed_as (optional)	updated name of the field, if renaming is intended.
display (optional)	Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"
page_no	Page number on which the field is to be created.
placeholder	String identifier for the in-person field, it can be Customer, Jack, CEO etc.
dimensions > x	Left location of the field in pixel.
dimensions > y	Top location of the field in pixel.
dimensions > width	Width of the field in pixel.
dimensions > height	Height of the field in pixel.
authentication > enabled	True, if authentication is enabled for the field.
authentication > sms_otp > enabled	True, if SMS OTP authentication is enabled for the field.
mobile_number	Mobile number of the recipient to which the field is assigned.
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.