Update TextBox Field - SigningHub-APIGuide

Business applications can use this service API to update a text box 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/text
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,` `"format":` `"dd/mm/yy",` `"placeholder":` `"",` `"value":` `"",` `"max_length": 100,` `"field_type":` `"NUMBER \| TEXT",` `"validation_rule":` `"MANDATORY",` `"font": {` `"name":` `"HELVETICA",` `"size": 12,` `"embedded_size": 7.5` `},` `"dimensions": {` `"x": 200,` `"y": 200,` `"width": 200,` `"height": 300` `}` `}`
	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.
page_no	Page number on which the field is to be created.
format	Text format of the field. Used for the date type field only. Possible values are m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy
placeholder	Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.
value	Value of the field. For type=DATE, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.
max_length	Maximum length of the value allowed in the field.
field_type	Field type with respect to accepting the type of values, possible values are "NUMBER" or "TEXT".
validation_rule	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
font > name	Name of the font selected for the text field. Possible values are "COURIER", "HELVETICA".
font > size	Size of the font selected for the text field. Possible values are "8", "10", "12", "14", "16", "18", "20"
font > embedded_size	Size of the font in the original PDF document.
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.
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.