Ta bort ett avtal med API:et.

Sök

Senast uppdaterad den 19 feb. 2025

Om du använder Acrobat Sign REST v6 API kan du permanent ta bort dina signerade avtal genom att använda åtgärden DELETE /agreements.

Steg

Aktivera API-dataförvaltning

Funktionen API-radering är inaktiverad som standard.

För att aktivera åtgärden DELETE /agreements/{agreementId} måste kontoadministratören skicka ett supportärende till Acrobat Sign-supporten.

Om du vill ha instruktioner steg för steg gällande manuell dataförvaltning kan du kolla in översikten för dataförvaltning/datalagring.

Identifiera de agreementID som du behöver ta bort

Gå till https://secure.adobesign.com/public/docs/restapi/v6.
Under avsnittet Avtal väljer du GET /agreements.
Välj Auktorisera för att skapa en åtkomsttoken.
Godkänn omfattningen (agreement_read:account)
Tillåt åtkomst när du uppmanas.

Detta kommer att skapa en lista över dina avtal med avtals-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 } ] }
```
{
  &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
    }
  ]
}
```

Användning av slutpunkterna Ta bort:

Det finns tre slutpunkter för DELETE/agreements.

DELETE /agreements/{agreementId}: tar bort avtalet. Avtalet är inte längre synligt för användaren på sidan Hantera.
DELETE /agreements/{agreementId}/documents: tar bort alla dokument som hör till ett avtal. Avtalet är synligt för användaren på sidan Hantera.
DELETE /agreements/{agreementId}/shares: tar bort delningsrelationer mellan avtalet och en användare.

Steg för att använda slutpunkterna Ta bort:

Välj åtgärden DELETE/agreements/ som ska köras.
Välj Auktorisera med omfattningen agreement_retention och Tillåt åtkomst om du uppmanas till det.
Ange agreementId för avtalet som du vill ta bort.
När avtalet har tagits bort har svarstexten ”inget innehåll”.

Fel när Delete /agreements är inaktiverat

Om åtgärden DELETE /agreements inte är aktiverad får du följande svar:

{

"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

"message": "Åtgärden kräver att vissa kontoinställningar är aktiverade. Kontakta Adobe Sign-teamet för att aktivera inställningarna."

}

{ "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED", "message": "Åtgärden kräver att vissa kontoinställningar är aktiverade. Kontakta Adobe Sign-teamet för att aktivera inställningarna." }

{
  &quot;code&quot;: &quot;DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED&quot;,
  &quot;message&quot;: &quot;Åtgärden kräver att vissa kontoinställningar är aktiverade. Kontakta Adobe Sign-teamet för att aktivera inställningarna.&quot;
}

Få hjälp snabbare och enklare

Ny användare?