Skip to main content
POST
/
packages
/
rescind
Rescind
curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/packages/rescind \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "packageId": "<string>"
}
'
{
  "packageId": "<string>"
}
The /packages/rescind endpoint allows you to rescind a package that has already been sent for signing. This operation cancels the signing process and optionally notifies all signers associated with the package.

​
Request

Request
POST /packages/rescind
{
 "packageId": "cf91071d-966d-41ea-b9bf-aa96a8e56c02",
 "rescindMessage": "The package has been rescinded due to an error in the documents.",
 "notify": true
}

​
Body

​
packageId
string
required
Unique identifier for the package to rescind.
​
rescindMessage
string
Message explaining why the package is being rescinded.
​
notify
boolean
Set to true to notify all signers about the rescind action.

​
Response

​
packageId
string
Unique identifier of the package rescinded.