Home > API Reference > Document Workflow > Add Placeholder to Workflow

Add Placeholder to Workflow

Business applications can use this service API to add placeholder to a workflow in a package.  A place holder is required when you do not know the identity of the intended recipient in a workflow.

Note the placeholder will be added as the last user in the workflow.  Hence further work may be required to remove a current user/group, already present in the workflow.

Adding a place holder allows you to proceed and add signature and/or input fields to the document, which can then be assigned to individual users at a later stage. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

https://api.signinghub.com/v3/packages/{package_id}/workflow/placeholder

HTTP Verb

POST

Authorization

Bearer {access_token}

Content-Type

application/json

Accept

application/json

Response Headers

Request Body

[
   {
      "placeholder": "Customer 1",
      "role": "SIGNER",
      "email_notification": true,
        "signing_order": 1
   }
]

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 are not allowed to perform this action on locked workflow"
}
{
   "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. 

 placeholder
The name of the new placeholder to be added in workflow.

 role (optional)
Role of the group as a recipient in the workflow. Possible value are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" and "INPERSON_HOST". 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. 

 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.





See also
Get Workflow Details
Update Workflow Details
Get Workflow History
Get Workflow History Details
Get Certificate Saved In Workflow History
Get Process Evidence Report
Update Post Processing
Add Users to Workflow
Update Workflow User
Add Groups to Workflow
Update Workflow Group
Update Placeholder
Get Workflow Users
Update Workflow Users Order
Get Workflow User Permissions
Update Workflow User Permissions
Get Workflow User Authentication (Document Opening)
Update Workflow User Authentication (Document Opening)
Delete Workflow User
Open Document via OTP (Generate)
Open Document via Password
Get Workflow Reminders
Update Workflow Reminders
Complete Workflow in the Middle (Terminate Workflow)