Přejít na dokumentaci
API

Pozvání člena

Podle e-mailu, s rolí a volitelně s adresami a celými doménami, které připadnou při přijetí pozvánky.

POSTapi.openemail.uk/members

Spustí skutečné volání proti vašemu pracovnímu prostoru, s vaším vlastním klíčem.

POST /members

Podle e-mailu, s rolí a volitelně s adresami a celými doménami, které připadnou při přijetí pozvánky.

Příklad

Vyžaduje members:write. Vrací 202 s pozvánkou. Nikdo není ve workspace, dokud ji nepřijme. access má výchozí hodnotu member a platí pro každé id v addressIds a domainIds.

curl
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"  }'
Odpověď
{  "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"}

POZVÁN JE KAŽDÝ. Ať už adresa účet OpenEmail má, nebo nemá, odpovědí je pozvánka a 202, nikdy člen. Nikdo není do workspace vložen bez přijetí a na tento endpoint platí totéž pravidlo jako na aplikaci. Někdo, kdo už ve workspace je, je odmítnut s member_is_owner, 422: co smí dělat, změňte místo toho přes PATCH /members/{userId} a přes volání pro udělení přístupu.

Pozvánka nese roli, adresy a celé domény, které uvedete, a udělí přesně je ve chvíli, kdy je přijata. Předtím se neuděluje nic. Celá doména pokrývá každou adresu na ní, včetně těch, které vznikly po odeslání pozvánky.

POST místo PUT na id uživatele, protože volající id uživatele nezná a může zvát někoho, kdo ještě účet nemá. Zná e-mailovou adresu.

Požádat podruhé do deseti minut je invitation_too_soon, 409. Potom se jediná nevyřízená pozvánka obnoví, vyrazí se nový odkaz a starý se vyřadí, místo aby se posílala druhá.

delivered: false znamená, že pozvánka existuje, ale e-mail neopustil poštovní server. deliveryError říká, co server odpověděl. Nic se k nim nedostalo, takže ji po uplynutí prodlevy pošlete znovu z aplikace.

invitedBy se záměrně nechává null, místo aby se přiřadilo vlastníkovi workspace. Ten sloupec zaznamenává, která OSOBA někoho pozvala, a API klíč není osoba.

Vlastník workspace je odmítnut s member_is_owner, 422. Není členem a členem se stát nemůže.