Delete an Agreement using the API.

Paieška

Paskutinį kartą atnaujinta 2025-02-06

If you are using Acrobat Sign REST v6 API, you can permanently delete your signed agreements by using the DELETE /agreements operation.

Steps

Enabling API Data Governance

The API Delete feature is off by default.

To enable the DELETE /agreements/{agreementId} operation, the Account Admin must submit a support ticket to Acrobat Sign Support.

For step-by-step instructions on manual data retention, check out the Data Governance/Retention Overview.

Identify the agreementIDs you need to delete

Navigate to https://secure.adobesign.com/public/docs/restapi/v6.
Under the Agreements section, select GET /agreements.
Select the Authorize button to create an access token.
Authorize the scope (agreement_read:account)
Allow Access when prompted.

This will produce a list of your agreements complete with agreement IDs:
{
"userAgreementList": [
{
"id": "CBJCHBCAABAAhKRLf4ITY7QiGc",
"type": "AGREEMENT",
"name": "Test Agreement",
"groupId": "CBJCHBCAABAAzHAworuZFe9",
"displayDate": "2024-11-22T13:49:07Z",
"displayParticipantSetInfos": [
{
"displayUserSetMemberInfos": [
{
"fullName": "Test Person",
"email": "Someone@email.com",
"company": "MyBusiness, Inc.",
"deliverableEmail": true
}
]
}
],
"latestVersionId": "3AAABLblqZhCpUEwbU5ASfzb3WZDVyw1YBtKJ8lRIXc0kJ8Rtaz",
"status": "OUT_FOR_SIGNATURE",
"hidden": false,
"esign": true
}
]
}
{ "userAgreementList": [ { "id": "CBJCHBCAABAAhKRLf4ITY7QiGc", "type": "AGREEMENT", "name": "Test Agreement", "groupId": "CBJCHBCAABAAzHAworuZFe9", "displayDate": "2024-11-22T13:49:07Z", "displayParticipantSetInfos": [ { "displayUserSetMemberInfos": [ { "fullName": "Test Person", "email": "Someone@email.com", "company": "MyBusiness, Inc.", "deliverableEmail": true } ] } ], "latestVersionId": "3AAABLblqZhCpUEwbU5ASfzb3WZDVyw1YBtKJ8lRIXc0kJ8Rtaz", "status": "OUT_FOR_SIGNATURE", "hidden": false, "esign": true } ] }
```
{
  "userAgreementList": [
    {
      "id": "CBJCHBCAABAAhKRLf4ITY7QiGc",
      "type": "AGREEMENT",
      "name": "Test Agreement",
      "groupId": "CBJCHBCAABAAzHAworuZFe9",
      "displayDate": "2024-11-22T13:49:07Z",
      "displayParticipantSetInfos": [
        {
          "displayUserSetMemberInfos": [
            {
              "fullName": "Test Person",
              "email": "Someone@email.com",
              "company": "MyBusiness, Inc.",
              "deliverableEmail": true
            }
          ]
        }
      ],
      "latestVersionId": "3AAABLblqZhCpUEwbU5ASfzb3WZDVyw1YBtKJ8lRIXc0kJ8Rtaz",
      "status": "OUT_FOR_SIGNATURE",
      "hidden": false,
      "esign": true
    }
  ]
}
```

Using the Delete endpoints:

There are three DELETE/agreements endpoints.

DELETE /agreements/{agreementId}: Deletes the agreement. The agreement is no longer visible on the Manage page of the user.
DELETE /agreements/{agreementId}/documents: Deletes all the documents of an agreement. The agreement is visible on the Manage page of the user.
DELETE /agreements/{agreementId}/shares: Deletes sharing relationships between the agreement and a user.

Steps to use the Delete endpoints:

Select the DELETE/agreements/ operation that is to run.
Select the Authorize button with the agreement_retention scope and Allow Access if prompted.
Provide the agreement of the agreement you want to delete.
Once the agreement is deleted, the Response Body has 'no content'.

Error when the Delete /agreements is disabled

If the DELETE /agreements operation is not enabled, you will receive the following response:

{

"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

"message": "The operation requires some account settings to be enabled. Please contact the Adobe Sign team to enable the settings."

}

{ "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED", "message": "The operation requires some account settings to be enabled. Please contact the Adobe Sign team to enable the settings." }

{
  "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
  "message": "The operation requires some account settings to be enabled. Please contact the Adobe Sign team to enable the settings."
}

Gaukite pagalbą greičiau ir lengviau

Naujas vartotojas?