ساخت مخاطب
یک مخاطب با جزئیات کامل میسازد و میتواند همزمان به گروهها اضافه کند.
POST
scope: phonebook.writehttps://api.irnoti.com/v1/phonebook/contactsحداقل یکی از mobile یا email لازم است. birth را شمسی بدهید (YYYY/MM/DD یا MM/DD) و در پایگاه داده میلادی ذخیره میشود. fields تا ۱۲ فیلد دلخواه (کلید ≤۴۰، مقدار ≤۲۰۰ نویسه).
پارامترها
| نام | محل | نوع | توضیح |
|---|---|---|---|
| mobile | بدنه | string | شمارهٔ موبایل. |
| بدنه | string | ایمیل. | |
| name | بدنه | string | نام. |
| lastName | بدنه | string | نام خانوادگی. |
| company | بدنه | string | شرکت. |
| city | بدنه | string | شهر. |
| note | بدنه | string | یادداشت. |
| birth | بدنه | string | تولد شمسی. |
| fields | بدنه | object | فیلدهای دلخواه. |
| groupIds | بدنه | string[] | گروههایی که مخاطب به آنها اضافه شود (حداکثر ۵۰). |
| optedOut | بدنه | boolean | لغو عضویت از ارسالها. |
خطاهای خاص این endpoint
| 401 | unauthorized | کلید API نامعتبر یا منقضی است. |
| 403 | insufficient_scope | کلید API دامنهٔ دسترسی لازم را ندارد. |
| 400 | validation_error | ورودی نامعتبر است (جزئیات در پاسخ). |
اجرای زنده (محیط تست)
باز کردن در کنسول کامل ←این endpoint در محیط تست پشتیبانی نمیشود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.