Ugrás a dokumentációra
API

Tag meghívása

E-mail cím alapján, szerepkörrel, és opcionálisan címekkel és teljes domainekkel, amelyek az elfogadáskor érvénybe lépnek.

POSTapi.openemail.uk/members

A valódi hívást futtatja le a munkaterületén, a saját kulcsával.

POST /members

E-mail cím alapján, szerepkörrel, és opcionálisan címekkel és teljes domainekkel, amelyek az elfogadáskor érvénybe lépnek.

Példa

members:write szükséges. 202-t ad vissza a meghívóval. Senki nincs a munkaterületen, amíg el nem fogadja. Az access alapértelmezése member, és az addressIds és domainIds minden azonosítójára vonatkozik.

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"  }'
Válasz
{  "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"}

MINDENKI MEGHÍVÁST KAP. Akár van már OpenEmail fiókja a címnek, akár nincs, a válasz egy meghívó és egy 202, soha nem egy tag. Senki nem kerül be egy munkaterületre elfogadás nélkül, és ez a végpont ugyanannak a szabálynak van alávetve, mint az alkalmazás. Aki már a munkaterületen van, azt member_is_owner kóddal, 422-vel utasítja el: a jogosultságait a PATCH /members/{userId} és a hozzáférés-megadó hívások módosítják.

A meghívó tartalmazza a szerepkört, a címeket és a megnevezett teljes domaineket, és az elfogadás pillanatában pontosan ezeket adja meg. Előtte semmit. Egy teljes domain minden rajta lévő címet lefed, a meghívó elküldése után létrehozottakat is.

POST és nem PUT egy felhasználói azonosítón, mert a hívó nem ismeri a felhasználói azonosítót, és olyasvalakit is meghívhat, akinek még nincs fiókja. Egy e-mail címet ismer.

Tíz percen belüli második kérés invitation_too_soon, 409. Ezután a meglévő függő meghívót frissíti, új linket hoz létre és a régit érvényteleníti, ahelyett hogy egy másodikat küldene.

A delivered: false azt jelenti, hogy a meghívó létezik, de az e-mail nem hagyta el a levelezőszervert. A deliveryError megmondja, mit válaszolt a szerver. Semmi nem jutott el hozzájuk, ezért a várakozási idő letelte után küldd el újra az alkalmazásból.

Az invitedBy szándékosan null marad, és nem a munkaterület tulajdonosához kerül. Az oszlop azt rögzíti, melyik SZEMÉLY hívott meg valakit, és egy API kulcs nem személy.

A munkaterület tulajdonosát member_is_owner kóddal, 422-vel utasítja el. Ő nem tag, és nem is tehető azzá.