Mời thành viên
Theo email, kèm một vai trò, và tùy chọn kèm các địa chỉ và toàn bộ tên miền sẽ được cấp khi họ chấp nhận.
Chạy lệnh gọi thật với không gian làm việc của bạn, bằng khóa của chính bạn.
POST /members
Theo email, kèm một vai trò, và tùy chọn kèm các địa chỉ và toàn bộ tên miền sẽ được cấp khi họ chấp nhận.
Ví dụ
Cần members:write. Trả về 202 kèm lời mời. Không ai ở trong không gian làm việc cho đến khi họ chấp nhận lời mời. access mặc định là member và áp dụng cho mọi id trong addressIds và 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"}MỌI NGƯỜI ĐỀU ĐƯỢC MỜI. Dù địa chỉ đó đã có tài khoản OpenEmail hay chưa, câu trả lời luôn là một lời mời và mã 202, không bao giờ là một thành viên. Không ai bị đưa vào không gian làm việc mà không chấp nhận, và endpoint này tuân theo cùng quy tắc với ứng dụng. Người đã ở trong không gian làm việc sẽ bị từ chối với member_is_owner, mã 422: hãy thay đổi những gì họ được làm bằng PATCH /members/{userId} và các lệnh cấp quyền.
Lời mời mang theo vai trò, các địa chỉ và toàn bộ tên miền bạn chỉ định, và cấp chính xác những thứ đó ngay khi được chấp nhận. Không có gì được cấp trước thời điểm đó. Một tên miền trọn vẹn bao gồm mọi địa chỉ trên nó, kể cả những địa chỉ được tạo sau khi lời mời được gửi.
Dùng POST thay vì PUT trên user id, vì bên gọi không biết user id và có thể đang mời người chưa có tài khoản. Họ biết một địa chỉ email.
Yêu cầu hai lần trong vòng mười phút sẽ nhận invitation_too_soon, mã 409. Sau đó, lệnh này làm mới lời mời đang chờ duy nhất, tạo liên kết mới và vô hiệu hóa liên kết cũ, thay vì gửi lời mời thứ hai.
delivered: false nghĩa là lời mời tồn tại nhưng email chưa rời máy chủ thư. deliveryError cho biết máy chủ đã phản hồi gì. Không có gì đến được với họ, vì vậy hãy gửi lại từ ứng dụng khi thời gian chờ đã qua.
invitedBy được cố ý để null thay vì gán cho chủ sở hữu không gian làm việc. Cột này ghi lại NGƯỜI nào đã mời ai đó, và khóa API không phải là một người.
Chủ sở hữu không gian làm việc bị từ chối với member_is_owner, mã 422. Họ không phải là thành viên và không thể trở thành thành viên.