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

ویرایش قانون

فقط فیلدهای ارسال‌شده تغییر می‌کنند.

PATCHhttps://api.irnoti.com/v1/email/rules/{id}
scope: email.manage

پاسخ موفق 204 است.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ قانون.
nameبدنهstringنام قانون.
mailboxIdبدنهstring | nullفقط یک صندوق؛ null یعنی همه.
matchAllبدنهbooleantrue یعنی همهٔ شرط‌ها (و)، false یعنی هرکدام (یا). پیش‌فرض true.
conditionsبدنهobject[]{field, op, value?}؛ field: from، to، subject، body، hasAttachment، category؛ op: contains، equals، startsWith، endsWith، not_contains، is_true (حداکثر ۱۰).
actionsبدنهobject[]یکی از: {type:"move",folder}، {type:"label",labelId}، markRead، star، {type:"forward",to}، {type:"category",category}، stop (حداکثر ۱۰).
sortبدنهnumberترتیب اجرا؛ کوچک‌تر زودتر.
enabledبدنهbooleanفعال یا غیرفعال.

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
404not_foundقانون پیدا نشد یا متعلق به شما نیست.
400validation_errorورودی نامعتبر است؛ خطای هر فیلد در details آمده است.

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

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

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

curl -X PATCH 'https://api.irnoti.com/v1/email/rules/2' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "enabled": false
}'
پاسخ نمونه200 OK
{}
ویرایش قانون — مستندات API | ایران ناتیفیکیشن