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

ویرایش مخاطب

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

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

مسدودکردن مخاطب با isBlocked: true انجام می‌شود.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ مخاطب.
emailبدنهstringنشانی ایمیل.
nameبدنهstringنام.
companyبدنهstringشرکت.
phoneبدنهstringتلفن.
noteبدنهstringیادداشت (حداکثر ۵۰۰ نویسه).
groupsبدنهstring[]گروه‌ها (حداکثر ۱۰).
isBlockedبدنهbooleanمسدود؛ نامهٔ این فرستنده به هرزنامه می‌رود.

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

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

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

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

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

curl -X PATCH 'https://api.irnoti.com/v1/email/contacts/31' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "isBlocked": true
}'
پاسخ نمونه200 OK
{
  "id": "31",
  "name": "علی رضایی",
  "note": null,
  "email": "ali@example.com",
  "phone": "09120000000",
  "groups": [
    "مشتری"
  ],
  "company": "نمونه",
  "isBlocked": true
}
ویرایش مخاطب — مستندات API | ایران ناتیفیکیشن