Belgelere geç
API

Bir üye davet et

E-posta ile, bir rolle ve isteğe bağlı olarak kabul ettiklerinde devreye giren adresler ve tüm alan adlarıyla.

POSTapi.openemail.uk/members

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

POST /members

E-posta ile, bir rolle ve isteğe bağlı olarak kabul ettiklerinde devreye giren adresler ve tüm alan adlarıyla.

Örnek

members:write gerektirir. Davetle birlikte 202 döner. Daveti kabul edene kadar kimse çalışma alanında değildir. access varsayılan olarak member'dır ve addressIds ile domainIds içindeki her id için geçerlidir.

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"  }'
Yanıt
{  "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"}

HERKES DAVET EDİLİR. Adresin zaten bir OpenEmail hesabı olsun ya da olmasın, yanıt bir davet ve bir 202'dir; asla bir üye değildir. Kimse kabul etmeden bir çalışma alanına konmaz ve bu uç nokta da uygulamayla aynı kurala tabidir. Çalışma alanında zaten bulunan biri member_is_owner ile, 422 olarak reddedilir: onun ne yapabileceğini bunun yerine PATCH /members/{userId} ve yetki çağrılarıyla değiştirin.

Davet, adlandırdığınız rolü, adresleri ve tüm alan adlarını taşır ve kabul edildiği anda tam olarak bunları verir. Öncesinde hiçbir şey verilmez. Tüm bir alan adı, davet gönderildikten sonra oluşturulanlar dahil üzerindeki her adresi kapsar.

Bir kullanıcı id'si üzerinde PUT yerine POST, çünkü çağıran kullanıcı id'sini bilmez ve henüz hesabı olmayan birini davet ediyor olabilir. Bildiği şey bir e-posta adresidir.

On dakika içinde ikinci kez istemek invitation_too_soon, bir 409'dur. Ondan sonra ikinci bir davet göndermek yerine bekleyen tek daveti tazeler, yeni bir bağlantı üretir ve eskisini geçersiz kılar.

delivered: false, davetin var olduğu ama e-postanın posta sunucusundan çıkmadığı anlamına gelir. deliveryError sunucunun ne dediğini belirtir. Karşı tarafa hiçbir şey ulaşmadı; bekleme süresi geçtikten sonra uygulamadan yeniden gönderin.

invitedBy bilerek null bırakılır, çalışma alanı sahibine atfedilmez. Sütun, birini hangi KİŞİNİN davet ettiğini kaydeder ve bir API anahtarı bir kişi değildir.

Çalışma alanı sahibi member_is_owner ile, 422 olarak reddedilir. Sahip bir üye değildir ve üye yapılamaz.