सदस्य आमंत्रित करें
ईमेल से, एक भूमिका के साथ, और वैकल्पिक रूप से उन पतों और पूरे डोमेन के साथ जो उनके स्वीकार करते ही उन्हें मिल जाते हैं।
असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।
POST /members
ईमेल से, एक भूमिका के साथ, और वैकल्पिक रूप से उन पतों और पूरे डोमेन के साथ जो उनके स्वीकार करते ही उन्हें मिल जाते हैं।
उदाहरण
members:write चाहिए। आमंत्रण के साथ 202 लौटाता है। जब तक कोई उसे स्वीकार न कर ले, वह वर्कस्पेस में नहीं होता। access का डिफ़ॉल्ट member है और यह addressIds तथा domainIds की हर id पर लागू होता है।
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} और ग्रांट कॉल इस्तेमाल करें।
आमंत्रण आपके बताए भूमिका, पतों और पूरे डोमेन को साथ ले जाता है, और स्वीकार होते ही ठीक वही सब दे देता है। उससे पहले कुछ नहीं दिया जाता। पूरा डोमेन उस पर मौजूद हर पते को कवर करता है, उन पतों को भी जो आमंत्रण भेजे जाने के बाद बने।
किसी user id पर PUT के बजाय POST, क्योंकि कॉल करने वाले को user id पता नहीं होती और हो सकता है वह ऐसे व्यक्ति को बुला रहा हो जिसका अभी खाता ही न हो। उन्हें एक ईमेल पता पता होता है।
दस मिनट के भीतर दोबारा माँगना invitation_too_soon, एक 409 है। उसके बाद यह दूसरा आमंत्रण भेजने के बजाय एकमात्र बकाया आमंत्रण को ताज़ा करता है, नया लिंक बनाता है और पुराना रद्द कर देता है।
delivered: false का अर्थ है कि आमंत्रण मौजूद है पर ईमेल मेल सर्वर से निकला नहीं। deliveryError बताता है कि सर्वर ने क्या कहा। उन तक कुछ नहीं पहुँचा, इसलिए कूलडाउन बीत जाने पर ऐप से दोबारा भेजें।
invitedBy जानबूझकर null छोड़ा जाता है, वर्कस्पेस के मालिक के नाम नहीं किया जाता। यह कॉलम दर्ज करता है कि किस व्यक्ति ने आमंत्रित किया, और API कुंजी कोई व्यक्ति नहीं है।
वर्कस्पेस के मालिक को member_is_owner, एक 422 के साथ मना किया जाता है। वे सदस्य हैं ही नहीं और बनाए भी नहीं जा सकते।