API'yi kullanarak bir Sözleşmeyi silin.

Ara

Son güncelleme: 18 Şub 2025

Acrobat Sign REST v6 API'yi kullanıyorsanız, DELETE /agreements işlemini kullanarak imzalı sözleşmelerinizi kalıcı olarak silebilirsiniz.

Adımlar

API Veri Yönetimini Etkinleştirme

API Silme özelliği varsayılan olarak devre dışıdır.

DELETE /agreements/{agreementId} işlemini etkinleştirmek için, Hesap Yöneticisi Acrobat Sign Destek ekibine destek talebi göndermelidir.

Manuel veri saklama hakkında adım adım talimatlar için Veri Yönetimi/Veri Saklama Konusuna Genel Bakış'a göz atın.

Silmeniz gereken sözleşme kimliklerini tanımlayın

https://secure.adobesign.com/public/docs/restapi/v6 adresine gidin.
Sözleşmeler bölümünden, GET /agreements öğesini seçin.
Erişim belirteci oluşturmak için Yetkilendir düğmesini seçin.
(agreement_read:account) kapsamını yetkilendirin
Sorulduğunda Erişime İzin Verin.

Bu işlem, sözleşme kimlikleriyle birlikte sözleşmelerin bir listesini üretecektir:
{
"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
    }
  ]
}
```

Delete uç noktalarını kullanarak:

Üç adet DELETE/agreements uç noktası vardır.

DELETE /agreements/{agreementId}: Sözleşmeyi siler. Sözleşme, kullanıcının Yönetim sayfasında artık görüntülenmez.
DELETE /agreements/{agreementId}/documents: Bir sözleşmenin tüm belgelerini siler. Sözleşme, kullanıcının Yönetim sayfasında artık görüntülenir.
DELETE /agreements/{agreementId}/shares: Sözleşme ile kullanıcı arasındaki paylaşım ilişkilerini siler.

Delete uç noktalarını kullanma adımları:

Çalıştırılacak DELETE/agreements/ işlemini seçin.
İstendiğinde, agreement_retention scope ve Erişime İzin Ver ile Yetkilendir düğmesini seçin.
Silmek istediğiniz sözleşmenin sözleşmesini girin.
Sözleşme silindikten sonra Yanıt Gövdesinde "içerik yok" mesajı görüntülenir.

Delete /agreements seçeneği devre dışı bırakıldığında hata

DELETE /agreements işlemi etkinleştirilmemişse aşağıdaki yanıtı alırsınız:

{

"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

"message": "Bu işlem için bazı hesap ayarlarının etkinleştirilmesi gerekiyor. Ayarları etkinleştirmek için lütfen Adobe Sign ekibiyle iletişime geçin."

}

{ "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED", "message": "Bu işlem için bazı hesap ayarlarının etkinleştirilmesi gerekiyor. Ayarları etkinleştirmek için lütfen Adobe Sign ekibiyle iletişime geçin." }

{
  &quot;code&quot;: &quot;DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED&quot;,
  &quot;message&quot;: &quot;Bu işlem için bazı hesap ayarlarının etkinleştirilmesi gerekiyor. Ayarları etkinleştirmek için lütfen Adobe Sign ekibiyle iletişime geçin.&quot;
}

Daha hızlı ve daha kolay yardım alın

Yeni kullanıcı mısınız?