Löschen einer Vereinbarung mithilfe der API

Suchen

Zuletzt aktualisiert am 25. Februar 2025

Wenn du die Acrobat Sign REST v6-API verwendest, kannst du deine signierten Vereinbarungen dauerhaft löschen, indem du die Funktion DELETE /agreements verwendest.

Schritte

Aktivieren der API-Data-Governance

Die API-Löschfunktion ist standardmäßig deaktiviert.

Um die Funktion DELETE /agreements/{agreementId} zu aktivieren, müssen Konto-Admins ein Support-Ticket an den Acrobat Sign-Support senden.

Schrittweise Anweisungen zur manuellen Datenspeicherung findest du im Überblick über Data Governance/Datenaufbewahrung.

Identifiziere die Vereinbarungs-IDs, die gelöscht werden sollen.

Navigiere zu https://secure.adobesign.com/public/docs/restapi/v6.
Wähle im Abschnitt Vereinbarungen die Option GET /agreements aus.
Wähle die Schaltfläche Autorisieren aus, um ein Zugriffstoken zu erstellen.
Autorisiere den Bereich (agreement_read:account).
Wähle Zugriff erlauben, wenn du dazu aufgefordert wirst.

Dadurch wird eine Auflistung deiner Vereinbarungen, einschließlich der Vereinbarungs-IDs, erstellt:
{
"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 } ] }
```
{
  &quot;userAgreementList&quot;: [
    {
      &quot;id&quot;: &quot;CBJCHBCAABAAhKRLf4ITY7QiGc&quot;,
      &quot;type&quot;: &quot;AGREEMENT&quot;,
      &quot;name&quot;: &quot;Test Agreement&quot;,
      &quot;groupId&quot;: &quot;CBJCHBCAABAAzHAworuZFe9&quot;,
      &quot;displayDate&quot;: &quot;2024-11-22T13:49:07Z&quot;,
      &quot;displayParticipantSetInfos&quot;: [
        {
          &quot;displayUserSetMemberInfos&quot;: [
            {
              &quot;fullName&quot;: &quot;Test Person&quot;,
              &quot;email&quot;: &quot;Someone@email.com&quot;,
              &quot;company&quot;: &quot;MyBusiness, Inc.&quot;,
              &quot;deliverableEmail&quot;: true
            }
          ]
        }
      ],
      &quot;latestVersionId&quot;: &quot;3AAABLblqZhCpUEwbU5ASfzb3WZDVyw1YBtKJ8lRIXc0kJ8Rtaz&quot;,
      &quot;status&quot;: &quot;OUT_FOR_SIGNATURE&quot;,
      &quot;hidden&quot;: false,
      &quot;esign&quot;: true
    }
  ]
}
```

Verwenden der Delete-Endpunkte:

Es gibt drei Endpunkte für DELETE/agreements.

DELETE /agreements/{agreementId}: Löscht die Vereinbarung. Die Vereinbarung ist auf der Seite Verwalten der nutzenden Person nicht mehr sichtbar.
DELETE /agreements/{agreementId}/documents: Löscht alle Dokumente im Zusammenhang mit einer Vereinbarung. Die Vereinbarung ist auf der Seite Verwalten der nutzenden Person sichtbar.
DELETE /agreements/{agreementId}/shares: Löscht die Freigabebeziehungen zwischen der Vereinbarung und einer nutzenden Person.

Schritte zum Verwenden der Delete-Endpunkte:

Wähle die DELETE/agreements-Funktion aus, die ausgeführt werden soll.
Wähle die Schaltfläche Autorisieren mit dem agreement_retention scope und Zugriff erlauben aus, wenn du dazu aufgefordert wirst.
Gib die Vereinbarungs-ID der Vereinbarung, die du löschen möchtest, an.
Sobald die Vereinbarung gelöscht wurde, hat der Antworttext keinen Inhalt mehr.

Fehler, wenn Delete/agreements deaktiviert ist

Wenn die Funktion DELETE /agreements nicht aktiviert ist, erhältst du folgende Antwort:

{

"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

"message": "Für den Vorgang müssen einige Kontoeinstellungen aktiviert werden. Wende dich an das Adobe Sign-Team, um die Einstellungen zu aktivieren.“

}

{ "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED", "message": "Für den Vorgang müssen einige Kontoeinstellungen aktiviert werden. Wende dich an das Adobe Sign-Team, um die Einstellungen zu aktivieren.“ }

{
  &quot;code&quot;: &quot;DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED&quot;,
  &quot;message&quot;: &quot;Für den Vorgang müssen einige Kontoeinstellungen aktiviert werden. Wende dich an das Adobe Sign-Team, um die Einstellungen zu aktivieren.“
}

Schneller und einfacher Hilfe erhalten

Neuer Benutzer?