Add Groups to Workflow - SigningHub-APIGuide

Business applications can use this service API to add groups as a recipient to a workflow. A SigningHub group means any member of the group can perform the action, i.e. sign, on behalf of all members of the group.

Note the group will be added as the last user/group in the workflow. Hence further work may be required to remove a current user/group, already present in 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/groups
HTTP Verb		POST
Content-Type		application/json
Accept		application/json
Authorization		Bearer {access_token}
Request Body		`[` `{` `"group_name":` `"HR",` `"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"` `}`
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"` `}`
		`{` `"Message":` `"You are not allowed to perform the requested operation"` `}`
404	Not Found	`{` `"Message":` `"Document not found"` `}`
		`{` `"Message":` `"Group or contact 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	ID of the package for which the group is to be added.
order	The order of workflow at which the group is to be added.
group_name	The name of the new group 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. If no value is provided, default value of "true" will be set.
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.