Uzaicināt dalībnieku
Pēc e-pasta adreses, ar lomu un pēc izvēles ar adresēm un veseliem domēniem, kas tiek piešķirti brīdī, kad uzaicinājums tiek pieņemts.
Izpilda īstu izsaukumu pret jūsu darbvietu, ar jūsu paša atslēgu.
POST /members
Pēc e-pasta adreses, ar lomu un pēc izvēles ar adresēm un veseliem domēniem, kas tiek piešķirti brīdī, kad uzaicinājums tiek pieņemts.
Piemērs
Nepieciešams members:write. Atgriež 202 ar uzaicinājumu. Neviens nav darbvietā, kamēr nav to pieņēmis. access noklusējums ir member, un tas attiecas uz katru id sarakstos addressIds un 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"}VISI TIEK UZAICINĀTI. Neatkarīgi no tā, vai adresei jau ir OpenEmail konts, atbilde ir uzaicinājums un 202, nekad ne dalībnieks. Neviens netiek ielikts darbvietā bez piekrišanas, un šim galapunktam ir tie paši noteikumi, kas lietotnei. Kāds, kas jau ir darbvietā, tiek atteikts ar member_is_owner, 422: to, ko viņš drīkst darīt, mainiet ar PATCH /members/{userId} un piešķīrumu izsaukumiem.
Uzaicinājums nes lomu, adreses un veselos domēnus, ko nosaucat, un piešķir tieši tos brīdī, kad tas tiek pieņemts. Pirms tam netiek piešķirts nekas. Vesels domēns aptver katru tā adresi, ieskaitot tās, kas izveidotas pēc uzaicinājuma nosūtīšanas.
POST, nevis PUT uz lietotāja id, jo izsaucējs lietotāja id nezina un var uzaicināt kādu, kam konta vēl nav. Viņš zina e-pasta adresi.
Otrs pieprasījums desmit minūšu laikā ir invitation_too_soon, 409. Pēc tam tas atsvaidzina vienīgo neizmantoto uzaicinājumu, izveido jaunu saiti un atsauc veco, nevis nosūta otru.
delivered: false nozīmē, ka uzaicinājums pastāv, bet e-pasts neaizgāja no pasta servera. deliveryError pasaka, ko serveris atbildēja. Viņus nekas nesasniedza, tāpēc, kad nogaidīšanas laiks pagājis, sūtiet to vēlreiz no lietotnes.
invitedBy ar nodomu ir atstāts null, nevis piedēvēts darbvietas īpašniekam. Šī kolonna reģistrē, kura PERSONA kādu uzaicināja, bet API atslēga nav persona.
Darbvietas īpašnieks tiek atteikts ar member_is_owner, 422. Viņš nav dalībnieks un par tādu nevar kļūt.