دعوت یک عضو
با ایمیل، همراه یک نقش، و به دلخواه با نشانیها و دامنههای کاملی که هنگام پذیرش دعوت به او میرسد.
فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا میکند.
POST /members
با ایمیل، همراه یک نقش، و به دلخواه با نشانیها و دامنههای کاملی که هنگام پذیرش دعوت به او میرسد.
نمونه
نیازمند members:write است. 202 را همراه دعوتنامه برمیگرداند. تا کسی دعوت را نپذیرد، در فضای کاری نیست. مقدار پیشفرض access برابر member است و بر هر شناسه در addressIds و domainIds اعمال میشود.
curl -X POST "$OE/members" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "roleId": "role_2b81de079c1f0a4b7e05d386", "domainIds": ["93542ff8-2baa-4f2f-841d-5ceaa074ab0d"], "access": "member" }'{ "object": "invitation", "id": "winv_6bb640f5b99e47deb758f1f5", "email": "[email protected]", "role": { "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "builtin": null }, "addresses": [], "domains": [ { "domainId": "93542ff8-2baa-4f2f-841d-5ceaa074ab0d", "domain": "acme.com", "access": "member" } ], "expiresAt": "2026-10-02T14:07:31.000Z", "delivered": true, "deliveryError": null, "createdAt": "2026-09-18T14:07:31.000Z"}همه دعوت میشوند. چه آن نشانی از پیش حساب OpenEmail داشته باشد چه نه، پاسخ یک دعوتنامه و یک 202 است، هرگز یک عضو. هیچکس بدون پذیرش وارد فضای کاری نمیشود و این اندپوینت به همان قاعدهای پایبند است که خود اپلیکیشن. کسی که پیشتر در فضای کاری است با member_is_owner و یک 422 رد میشود: به جایش با PATCH /members/{userId} و فراخوانیهای اعطای دسترسی تغییر دهید که چه کاری میتواند بکند.
دعوتنامه نقش، نشانیها و دامنههای کاملی را که نام بردهاید با خود میبرد و همان لحظهای که پذیرفته شود دقیقاً همانها را اعطا میکند. پیش از آن هیچچیز اعطا نمیشود. یک دامنهٔ کامل همهٔ نشانیهای روی آن را در بر میگیرد، از جمله نشانیهایی که پس از فرستادن دعوت ساخته میشوند.
POST به جای PUT روی یک شناسهٔ کاربر، چون فراخوانکننده شناسهٔ کاربر را نمیداند و ممکن است کسی را دعوت کند که هنوز حسابی ندارد. آنچه میداند یک نشانی ایمیل است.
درخواست دوباره در فاصلهٔ ده دقیقه invitation_too_soon است، یک 409. پس از آن، همان یک دعوتنامهٔ در جریان را تازه میکند، پیوندی نو میسازد و پیوند پیشین را بازنشسته میکند، به جای فرستادن دعوت دوم.
delivered: false یعنی دعوتنامه وجود دارد اما ایمیل از سرور ایمیل بیرون نرفته است. deliveryError میگوید سرور چه گفته است. چیزی به دست او نرسیده، پس پس از سپریشدن دورهٔ انتظار دوباره از داخل اپلیکیشن بفرستید.
invitedBy عمداً null گذاشته میشود و به مالک فضای کاری نسبت داده نمیشود. آن ستون ثبت میکند کدام شخص کسی را دعوت کرده است، و یک کلید API شخص نیست.
مالک فضای کاری با member_is_owner رد میشود، یک 422. او عضو نیست و نمیتوان او را عضو کرد.