پرش به مستندات
API

ساختن یک مخاطب

یک نشانی را در دفترچه نشانی‌های فضای کاری ذخیره می‌کند. نشانی خودِ هویت است، پس نه شناسه‌ای برای انتخاب هست و نه شناسه‌ای در پاسخ. پیش از ذخیره هرس و به حروف کوچک تبدیل می‌شود، و مخاطب با `source` برابر `manual` ذخیره می‌شود. مخاطب تازه هم‌زمان با نوشته‌شدنش به گروه مخاطبان پیش‌فرضِ درون‌ساخت می‌پیوندد، به‌علاوهٔ هر چیزی که در `audienceIds` نام برده شده باشد.

POSTapi.openemail.uk/contacts

فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

POST /contacts

یک نشانی را در دفترچه نشانی‌های فضای کاری ذخیره می‌کند. نشانی خودِ هویت است، پس نه شناسه‌ای برای انتخاب هست و نه شناسه‌ای در پاسخ. پیش از ذخیره هرس و به حروف کوچک تبدیل می‌شود، و مخاطب با source برابر manual ذخیره می‌شود. مخاطب تازه هم‌زمان با نوشته‌شدنش به گروه مخاطبان پیش‌فرضِ درون‌ساخت می‌پیوندد، به‌علاوهٔ هر چیزی که در audienceIds نام برده شده باشد.

نمونه

به contacts:write نیاز دارد. فرستادن audienceIds به audiences:write هم نیاز دارد.

curl
curl -X POST "$OE/contacts" -H "$AUTH" -H 'content-type: application/json' -d '{  "email": "[email protected]",  "name": "Grace Hopper",  "notes": "Met at the compiler workshop"}'
پاسخ
{  "object": "contact",  "email": "[email protected]",  "name": "Grace Hopper",  "source": "manual",  "notes": "Met at the compiler workshop",  "lastSeenAt": null,  "createdAt": "2026-09-18T09:00:00.000Z",  "updatedAt": "2026-09-18T09:00:00.000Z",  "audiences": [    { "id": "aud_9f2c4b7e1a0d63d84c5f2e7b", "name": "All contacts", "builtin": "default" }  ]}

نشانی‌ای که از پیش در دفترچه است 409 contact_exists می‌گیرد و ادغام نمی‌شود، پس یک تلاش دوباره نمی‌تواند بی‌سروصدا نامی را که کسی در برنامه ویرایش کرده بازنویسی کند. به‌جایش ردیف را بخوانید و PATCH کنید.

lastSeenAt تا وقتی نامه‌ای از نویسندهٔ برنامه به آن نشانی نرود null می‌ماند. source و lastSeenAt از آنِ سرورند و در بدنه پذیرفته نمی‌شوند.

شناسهٔ گروهی در audienceIds که در این فضای کاری وجود ندارد 404 می‌گیرد و چیزی نوشته نمی‌شود.