Skip to main content
POST
/
packages
/
delete
Delete
curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/packages/delete \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "packageId": "<string>"
}
'
{
  "packageId": "<string>",
  "videos": [
    {
      "meetingVideoId": "<string>",
      "meetingVideoSharedId": "<string>",
      "meetingId": "<string>",
      "meetingSessionId": "<string>",
      "externalVideoId": "<string>",
      "externalStorageId": "<string>",
      "timeCreated": "<string>",
      "timeRetention": "<string>",
      "timeDeleted": "<string>",
      "duration": "<string>",
      "size": 123,
      "source": "<string>",
      "type": "<string>",
      "state": "<string>",
      "url": "<string>",
      "timeUrlExpires": "<string>"
    }
  ]
}
The /packages/delete endpoint allows you to delete an existing package from the iinked Sign platform. Once a package is deleted, all signers associated with the package will no longer be able to access or sign the documents within that package.
You can alternatively rescind a package using the /packages/rescind endpoint, which notifies all signers that the package has been rescinded but retains the package and its documents in the platform.
Please note that this will mark the package and all of its documents and videos for permanent deletion from the iinked Sign platform and you should only do so if you no longer need the package.

​
Request

Request
POST /packages/delete
{
 "packageId": "cf91071d-966d-41ea-b9bf-aa96a8e56c02",
 "notify": true,
 "overrideRetention": false
}

​
Body

​
packageId
string
required
Unique identifier for the package.
​
notify
boolean
When true, notifies all signers of the package deletion via email. When false, no notifications are sent.
​
overrideRetention
boolean
When true, overrides any retention policies that would normally prevent the package from being deleted.
Use with caution.

​
Response

​
packageId
string
Unique identifier of the package deleted.
​
videos
object[]
List of videos that were deleted from the package.