Complete Workflow in the Middle (Terminate Workflow)

Business applications can mark the workflow completed even in the middle of the workflow. Use this service API to change the status of the workflow to completed. If there are recipients who have not signed the document yet. Their signature will not be required any more and they will not be able to see the document in their inbox any further.

Bearer token should belong to document owner or enterprise admin can use scope variable to get the access token on behalf of document owner to perform this action.

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

HTTP Verb

POST

Authorization

Bearer {access_token}

Content-Type

application/json

Response Headers

Request Body

Status Code

Message

Response Body

200

400

Bad Request

{

"Message": "You are not authorized to view this document"

}

403

Forbidden

{

"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 "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	The package ID from which the recipient is to be deleted.
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.