پرش به مستندات
API

خالی کردن یک گروه مخاطب

همهٔ مخاطبان را در یک تراکنش از گروه بیرون می‌آورد. گروه با شناسه، نام و توضیحش باقی می‌ماند، و هر مخاطب در دفترچهٔ نشانی‌ها، در گروه مخاطبان پیش‌فرض و در گروه‌های دیگرش می‌ماند.

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

فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

POST /audiences/{id}/empty

همهٔ مخاطبان را در یک تراکنش از گروه بیرون می‌آورد. گروه با شناسه، نام و توضیحش باقی می‌ماند، و هر مخاطب در دفترچهٔ نشانی‌ها، در گروه مخاطبان پیش‌فرض و در گروه‌های دیگرش می‌ماند.

نمونه

به audiences:write نیاز دارد. بدنه‌ای ندارد.

curl
curl -X POST "$OE/audiences/aud_4c1b8e2a7d9f05c36b4e8a71/empty" -H "$AUTH"
پاسخ
{  "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}

پاسخ، گروه است به شکل کنونی‌اش، به‌علاوهٔ removed، یعنی شمار عضویت‌های برداشته‌شده. خالی کردن گروهی که از پیش خالی است removed: 0 برمی‌گرداند.

بازگشتی در کار نیست، و هیچ چیزی ثبت نمی‌کند چه کسانی در فهرست بوده‌اند. اگر ممکن است آن را دوباره بخواهید، نخست GET /audiences/{id}/contacts را پیمایش کنید. برنامه پیش از خالی کردن یک فهرست از کاربر می‌خواهد هویتش را تأیید کند، و کلید چنین گامی ندارد، پس audiences:write را آگاهانه واگذار کنید.

گروه مخاطبان پیش‌فرض داخلی را نمی‌توان خالی کرد. آن فراخوانی با 409 audience_immutable رد می‌شود.