Update Placeholder - SigningHub-APIGuide

Business applications can use this service API to update a placeholder in the workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific place holder within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow place holder is identified by the order at which it is added to the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/placeholder
HTTP Verb		PUT
Authorization		Bearer {access_token}
Content-Type		application/json
Accept		application/json
Response Headers
Request Body		{ `"placeholder":` `"Customer 2",` `"role":` `"SIGNER",` `"email_notification":` `true, "signing_order": 2` `}`
Status Code	Message	Response Body
200	OK
400	Bad Request	`{` `"Message":` `"Recipient role is not supported for an XML type document"` `}`
403	Forbidden	`{` `"Message":` `"You cannot access this document after the access period ends"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
		`{` `"Message":` `"You are not allowed to perform the requested operation"` `}`
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	ID of the package for which the placeholder is to be added.
order	Order of the recipient in the workflow.
placeholder (optional)	The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained.
role (optional)	Role of the group as a recipient in the workflow. Possible value are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" and "INPERSON_HOST". If no value is provided, old value will be retained. However, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
email_notification (optional)	Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.
signing_order (optional)	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
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.