上次更新日期：
2025年2月18日
如果您使用 Acrobat Sign REST v6 API，您可以通过使用DELETE /agreements 操作永久删除已签名协议。
步骤
启用 API 数据管理
默认情况下关闭 API 删除功能。
要启用 DELETE /agreements/{agreementId} 操作，帐户管理员必须向 Acrobat Sign 支持人员提交支持票证。
有关手动数据保留的分步指导说明，请查看数据治理/保留概述。
确定要删除的 agreementID
-
-
在协议部分下，选择 GET /agreements。
-
选择授权按钮以创建访问令牌。
-
授权范围 (agreement_read:account)
-
如果出现系统提示，请允许访问。
这将生成一份包含协议 ID 的协议列表：
{"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 } ] }
使用删除端点。
有三种 DELETE/agreements 端点。
- DELETE /agreements/{agreementId}：删除此协议。 此协议在用户的管理页面上不可见。
- DELETE /agreements/{agreementId}/documents：删除协议的所有文档。 此协议在用户的管理页面上可见。
- DELETE /agreements/{agreementId}/shares: 删除协议和用户之间的共享关系。
步骤使用删除端点：
-
选择要运行的 DELETE/agreements/ 操作。
-
选择具有 agreement_retention 范围授权按钮以及如果出现系统提示，请允许访问。
-
提供要删除的协议的协议。
-
删除协议后，响应正文中“无内容”。
禁用 Delete /agreements 时出错
如果未启用 DELETE /agreements 操作，您将收到以下响应：
{
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "该操作需要启用一些帐户设置。 Please contact the Adobe Sign team to enable the settings."
}
{
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "该操作需要启用一些帐户设置。 Please contact the Adobe Sign team to enable the settings."
}
{
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "该操作需要启用一些帐户设置。 Please contact the Adobe Sign team to enable the settings."
}
