POST Create Invitation endpoint.
Endpoint
POST
/web/v1/system/invitations WEBAuthentication
- Chain: WEB
- JWT Token: true
- API Key: false
- Permissions: ["workspace:invitation:write"]
Rate Limit
Standard rate limit applies.
Headers
Frontend Headers
| Header | Required | Description |
|---|---|---|
| X-LOCALE | Yes | 用户的 locale |
| Accept-Language | No | 语言偏好 |
Cloudflare Headers
| Header | Required | Description |
|---|---|---|
| CF-Connecting-IP | Yes | Client IP from Cloudflare |
| CF-IPCountry | Yes | Client country code |
| CF-Ray | Yes | Cloudflare Ray ID |
| CF-Visitor | Yes | Visitor scheme |
| CF-Worker | No | Cloudflare Worker indicator |
| CF-TCP-Port | No | Client TCP port |
| CF-Edge-Keep-Alive | No | Edge keep-alive status |
| CF-Cache-Status | No | Cache status |
| CDN-Loop | No | CDN loop detection |
| X-Real-IP | Yes | Real client IP |
Nginx Headers
| Header | Required | Description |
|---|---|---|
| X-PORTAL-ACCESS-CODE | Yes | Portal access code |
| X-Real-IP | Yes | 客户端真实 IP |
| X-Forwarded-For | Yes | 代理链 |
| X-Forwarded-Proto | Yes | 协议 |
Request Parameters
Body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
| inviteeEmail | String | Yes | 被邀请人邮箱 |
| roleBizId | String | Yes | |
| message | String | No | 邀请消息 |
| expirationDays | Integer | No | 过期天数 |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| data.bizId | String | 业务 ID |
| data.workspaceBizId | String | 工作空间业务 ID |
| data.workspaceName | String | 工作空间名称 |
| data.inviterBizId | String | 邀请人业务 ID |
| data.inviterName | String | 邀请人名称 |
| data.inviteeEmail | String | 被邀请人邮箱 |
| data.inviteeAccountBizId | String | 被邀请人账户业务 ID |
| data.inviteeAccountName | String | 被邀请人账户名称 |
| data.invitationStatus | UserInvitationStatus | 邀请状态 |
| data.message | String | 邀请消息 |
| data.expiresAt | Instant | 过期时间 |
| data.acceptedAt | Instant | 接受时间 |
| data.createdAt | Instant | 创建时间 |
| data.canAccept | boolean | 是否可接受 |