Suppression d’un accord à l’aide d’une API

Rechercher

Dernière mise à jour le 18 févr. 2025

Si vous utilisez l’API REST V6 d’Acrobat Sign, vous pouvez supprimer définitivement vos accords signés en utilisant l’opération de DELETE /agreements.

Étapes

Activation de la gouvernance des données API

La fonction de suppression de l’API est désactivée par défaut.

Pour activer l’opération de DELETE /agreements/{agreementId}, l’administrateur de compte doit envoyer un ticket à l’assistance Acrobat Sign.

Pour obtenir des instructions étape par étape sur la conservation manuelle des données, consultez la vue d’ensemble sur la gouvernance et la conservation des données.

Identification des ID d’accord à supprimer

Accédez à https://secure.adobesign.com/public/docs/restapi/v6.
Dans la section Accords, sélectionnez GET /agreements.
Cliquez sur le bouton Autoriser pour créer un jeton d’accès.
Autorisez la portée (agreement_read:account).
Autorisez l’accès lorsque vous y êtes invité.

Vous obtiendrez ainsi une liste de vos accords avec les ID d’accord :
{
"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
    }
  ]
}
```

Utilisation des points d’entrée Supprimer :

Il existe trois points d’entrée DELETE/agreements.

DELETE /agreements/{agreementId} : supprime l’accord. L’accord n’est plus visible dans la page Gérer de l’utilisateur.
DELETE /agreements/{agreementId}/documents : supprime tous les documents d’un accord. L’accord est visible dans la page Gérer de l’utilisateur.
DELETE /agreements/{agreementId}/shares : supprime les relations de partage entre un accord et un utilisateur.

Utilisation des points d’entrée Supprimer :

Sélectionnez l’opération DELETE /agreements à exécuter.
Sélectionnez le bouton Autoriser avec la portée agreement_retention et autorisez l’accès si vous y êtes invité.
Indiquez l’accord à supprimer.
Une fois l’accord supprimé, le corps de la réponse affiche « aucun contenu ».

Erreur lorsque la fonction Delete /agreements est désactivée

Si l’opération DELETE /agreements est désactivée, vous recevrez la réponse suivante :

{

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

Recevez de l’aide plus rapidement et plus facilement

Nouvel utilisateur ?