ویرایش مخاطب
فقط فیلدهای ارسالشده تغییر میکنند.
PATCH
scope: email.managehttps://api.irnoti.com/v1/email/contacts/{id}مسدودکردن مخاطب با isBlocked: true انجام میشود.
پارامترها
| نام | محل | نوع | توضیح |
|---|---|---|---|
| id * | مسیر | string | شناسهٔ مخاطب. |
| بدنه | string | نشانی ایمیل. | |
| name | بدنه | string | نام. |
| company | بدنه | string | شرکت. |
| phone | بدنه | string | تلفن. |
| note | بدنه | string | یادداشت (حداکثر ۵۰۰ نویسه). |
| groups | بدنه | string[] | گروهها (حداکثر ۱۰). |
| isBlocked | بدنه | boolean | مسدود؛ نامهٔ این فرستنده به هرزنامه میرود. |
خطاهای خاص این endpoint
| 401 | unauthorized | کلید API نامعتبر یا منقضی است. |
| 403 | insufficient_scope | کلید API دامنهٔ دسترسی لازم را ندارد. |
| 404 | not_found | مخاطب پیدا نشد یا متعلق به شما نیست. |
| 400 | validation_error | ورودی نامعتبر است؛ خطای هر فیلد در details آمده است. |
اجرای زنده (محیط تست)
باز کردن در کنسول کامل ←این endpoint در محیط تست پشتیبانی نمیشود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.