ایران ناتیفیکیشن

لغو ایمیل زمان‌بندی‌شده

نامهٔ زمان‌بندی‌شدهٔ هنوز ارسال‌نشده را لغو و هزینه را برمی‌گرداند.

POSThttps://api.irnoti.com/v1/email/outbound/{id}/cancel
scope: email.send

فقط برای نامه‌های queued با scheduledAt در آینده؛ در غیر این صورت 409 cannot_cancel.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ ایمیل.

خطاهای خاص این endpoint

409cannot_cancelنامه دیگر قابل لغو نیست.
401unauthorizedکلید API نامعتبر یا منقضی است.
403feature_disabledقابلیت ایمیل (یا دامنهٔ دسترسی لازم) برای کلید/حساب شما فعال نیست.

اجرای زنده (محیط تست)

باز کردن در کنسول کامل ←

این endpoint در محیط تست پشتیبانی نمی‌شود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.

curl -X POST 'https://api.irnoti.com/v1/email/outbound/5012/cancel' \
  -H "Authorization: Bearer $IRNOTI_KEY"
پاسخ نمونه200 OK
{}
لغو ایمیل زمان‌بندی‌شده — مستندات API | ایران ناتیفیکیشن