Slette en avtale ved hjelp av API-et.

Søk

Sist oppdatert 19. feb. 2025

Hvis du bruker Acrobat Sign REST v6 API, kan du slette de signerte avtalene dine permanent ved å bruke DELETE /agreements.

Trinn

Aktivere API-datastyring

Slett API-funksjonen er ikke aktivert som standard.

Hvis du vil aktivere DELETE /agreements/{agreementId}, må kontoadministratoren sende en støtteforespørsel til kundestøtten for Acrobat Sign.

Du finner trinnvise instruksjoner om manuell dataoppbevaring i Oversikt over datastyring/dokumentoppbevaring.

Velg agreementID-ene du ønsker å slette

Gå til https://secure.adobesign.com/public/docs/restapi/v6.
Under Avtaler velger du GET /agreements.
Velg Autoriser for å opprette et tilgangstoken.
Godkjenn omfanget (agreement_read:account)
Gi tilgang hvis du blir spurt om det.

Dette vil gi deg en liste over de fullførte avtalene dine med avtale-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
    }
  ]
}
```

Bruke Slett endepunktene:

Det finnes tre DELETE/agreements-endepunkter.

DELETE /agreements/{agreementId}: Sletter avtalen. Avtalen er ikke lenger synlig på brukerens Behandle-side.
DELETE /agreements/{agreementId}/documents: Sletter alle dokumenter knyttet til en avtale. Avtalen er synlig på Behandle-siden til brukeren.
DELETE /agreements/{agreementId}/shares: Sletter delingsrelasjoner mellom avtalen og en bruker.

Trinn for å bruke Slett-endepunktene:

Velg DELETE/agreements/ -operasjonen som skal kjøres.
Trykk på Autoriser med omfanget agreement_retention og Gi tilgang hvis du blir bedt om det.
Oppgi avtale-ID-en for avtalen du vil slette.
Når avtalen er slettet, er svarteksten uten innhold.

Feil når Delete /agreements er deaktivert

Hvis operasjonen DELETE /agreements ikke er aktivert, får du følgende melding:

{

"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." }

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

Få hjelp raskere og enklere

Ny bruker?