Assign Document Field - SigningHub-APIGuide

Business applications can use this service API to assign users to input fields, e.g. signature fields, and hence define the signing order. The fields must already be present in the document and the users must be present in the workflow. The ID of the workflow document is provided in the resource URL, along with the package identifier.

When recipients are in a workflow they are numbered, beginning at one and counting up for each extra one. Therefore, if there are three users in a workflow they are numbered "1", "2", and "3" respectfully. This API call allows you to assign a user by their workflow order number, to an input field on the document.

https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/fields/assign
HTTP Verb		PUT
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		[ `{` `"field_name":` `"SH_SIGN_RandomNumber",` `"order": 1` `},` `{` `"field_name":` `"SH_SIGN_RandomNumber",` `"order": 2` `}` `]`
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":` `"Document is no longer in draft state"` `}`
		`{` `"Message":` `"You are not allowed to perform this action on locked workflow"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
404	Not Found	`{` `"Message":` `"Document not found"` `}`
		`{` `"Message":` `"Signature field not found"` `}`
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 "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 workflow user needs to be updated.
order	The order of the user in workflow, to which the field is being assigned.
field_name	Name of the signature field that is to be 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.