Slet en aftale ved hjælp af API'en.

Søg

Sidst opdateret den 19. feb. 2025

Hvis du bruger Acrobat Sign REST v6 API, kan du slette dine underskrevne aftaler permanent ved at bruge handlingen DELETE /agreements.

Trin

Aktivering af API-datastyring

API-slettefunktionen er deaktiveret som standard.

For at handlingen DELETE /agreements/{agreementId} kan aktivere, skal kontoadministratoren sende en supportanmodning til Acrobat Sign Support.

Du kan finde trinvise vejledninger til manuel dataopbevaring i oversigten over datastyring/-opbevaring.

Identificer de aftale-id'er, du skal slette

Gå til https://secure.adobesign.com/public/docs/restapi/v6.
Under sektionen Aftaler skal du vælge GET /agreements.
Vælg knappen Godkend for at oprette en adgangstoken.
Godkend omfanget (agreement_read:account)
Giv adgang, når du bliver bedt om det.

Herefter vises en liste over dine aftaler, der er fuldført, med aftale-id'er:
{
"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
    }
  ]
}
```

Brug af Slet slutpunkter:

Der er tre DELETE/agreements-slutpunkter.

DELETE /agreements/{agreementId}: Sletter aftalen. Aftalen er ikke længere synlig på brugerens Administrationsside.
DELETE /agreements/{agreementId}/documents: Sletter alle dokumenter til en aftale. Aftalen er synlig på brugerens Administrationsside.
DELETE /agreements/{agreementId}/shares: Sletter delingsrelationer mellem aftalen og en bruger.

Trin til at bruge Slet-slutpunkter:

Vælg handlingen DELETE/agreements, som skal køres.
Vælg knappen Godkend med omfanget agreement_retention og Tillad adgang, hvis du bliver bedt om det.
Angiv aftalen til den aftale, du vil slette.
Når aftalen er slettet, har svarets brødtekst "intet indhold".

Fejl, når Delete /agreements er deaktiveret

Hvis handlingen DELETE /agreements ikke er aktiveret, modtager du følgende svar:

{

"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

"message": "Handlingen kræver, at nogle kontoindstillinger skal aktiveres. Kontakt Adobe Sign-teamet for at aktivere indstillingerne."

}

{ "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED", "message": "Handlingen kræver, at nogle kontoindstillinger skal aktiveres. Kontakt Adobe Sign-teamet for at aktivere indstillingerne." }

{
 &quot;code&quot;: &quot;DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED&quot;,
 &quot;message&quot;: &quot;Handlingen kræver, at nogle kontoindstillinger skal aktiveres. Kontakt Adobe Sign-teamet for at aktivere indstillingerne.&quot;
}

Få hjælp hurtigere og nemmere

Ny bruger?