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

ویرایش مخاطب

فیلدهای مخاطب را به‌روز می‌کند.

PATCHhttps://api.irnoti.com/v1/phonebook/contacts/{id}
scope: phonebook.write

فقط فیلدهای ارسالی تغییر می‌کنند. optedOut: true مخاطب را از همهٔ ارسال‌ها کنار می‌گذارد.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ مخاطب.
mobileبدنهstringموبایل.
nameبدنهstringنام.
emailبدنهstringایمیل.
optedOutبدنهbooleanلغو عضویت.
fieldsبدنهobjectفیلدهای دلخواه.

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

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

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

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

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

curl -X PATCH 'https://api.irnoti.com/v1/phonebook/contacts/801' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "علی‌اکبر"
}'
پاسخ نمونه200 OK
{
  "id": "801",
  "name": "علی‌اکبر"
}
ویرایش مخاطب — مستندات API | ایران ناتیفیکیشن