POST Create Invitation endpoint.
Endpoint
POST
/web/v1/partner/invitations WEBAuthentication
- Chain: WEB
- JWT Token: true
- API Key: false
- Permissions: ["workspace:invitation:write"]
- Secure Channel: DISABLED
Rate Limit
120 requests per 60 seconds.
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 |
| 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 | Invitee email |
| roleBizId | String | Yes | Role business ID |
| message | String | No | Invitation message (max 500) |
| expirationDays | Integer | No | Expiration days (1-30, default 7) |
Response
201 Created
| Field | Type | Description |
|---|---|---|
| bizId | String | Business ID |
| workspaceBizId | String | Workspace business ID |
| workspaceName | String | Workspace name |
| inviterBizId | String | Inviter business ID |
| inviterName | String | Inviter name |
| inviteeEmail | String | Invitee email |
| inviteeAccountBizId | String | Invitee account business ID |
| inviteeAccountName | String | Invitee account name |
| invitationStatus | UserInvitationStatus | Invitation status |
| message | String | Invitation message |
| expiresAt | Instant | Expiry time |
| acceptedAt | Instant | Accept time |
| createdAt | Instant | Creation time |
| canAccept | boolean | Can accept |