Belgelere geç
API

Bir kitleyi boşaltma

Kitledeki her kişiyi tek bir işlemde çıkarır. Kitle kimliği, adı ve açıklamasıyla kalır; her kişi adres defterinde, varsayılan kitlede ve diğer kitlelerinde kalır.

POSTapi.openemail.uk/audiences/{id}/empty

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

POST /audiences/{id}/empty

Kitledeki her kişiyi tek bir işlemde çıkarır. Kitle kimliği, adı ve açıklamasıyla kalır; her kişi adres defterinde, varsayılan kitlede ve diğer kitlelerinde kalır.

Örnek

audiences:write gerektirir. Gövde yoktur.

curl
curl -X POST "$OE/audiences/aud_4c1b8e2a7d9f05c36b4e8a71/empty" -H "$AUTH"
Yanıt
{  "object": "audience",  "id": "aud_4c1b8e2a7d9f05c36b4e8a71",  "name": "Product updates",  "description": "Customers who asked to hear about releases",  "builtin": null,  "contactCount": 0,  "lastContactAt": null,  "createdAt": "2026-09-18T09:10:00.000Z",  "updatedAt": "2026-09-18T09:10:00.000Z",  "removed": 3}

Yanıt, kitlenin şimdiki hâli ile removed, yani kaldırılan üyelik sayısıdır. Zaten boş olan bir kitleyi boşaltmak removed: 0 döndürür.

Geri alma yoktur ve listede kimin olduğu hiçbir yerde kaydedilmez. Listeyi geri isteyebilecekseniz önce GET /audiences/{id}/contacts üzerinden tüm sayfaları dolaşın. Uygulama bir listeyi boşaltmadan önce kişiden kim olduğunu doğrulamasını ister, bir anahtarda ise böyle bir adım yoktur; bu yüzden audiences:write iznini bilinçli olarak verin.

Yerleşik varsayılan kitle boşaltılamaz. Bu çağrı 409 audience_immutable ile reddedilir.