Cancel Invitation
POST
/web/v1/workspaces/{workspaceBizId}/invitations/cancel JWTCancels a pending workspace invitation. Only PENDING invitations can be cancelled.
Required Headers
| Header | Example Value | Description |
|---|---|---|
| Content-Type | application/json | Request content type |
| Accept | application/json | Expected response type |
| X-Client-Hash | Client device fingerprint | |
| Accept-Language | en, zh, zh-Hant, ja, vi | Response language (default: en) |
| Authorization | Bearer | JWT access token |
| X-Workspace-Id | Target workspace ID |
Request Parameters
| Name | Type | Required | In | Description |
|---|---|---|---|---|
workspaceBizId | String | Required | path | Business ID of the workspace |
Request Body
json
{
"invitationBizId": "inv_abc123def456",
"reason": "Invitation cancelled"
}Request Example
json
{
"invitationBizId": "INV-001",
"reason": "No longer needed"
}Success Response
Status: 200 OK
Success 200
{
"version": "1.3.0",
"timestamp": 1709337600000,
"success": true,
"code": "2000",
"message": "SUCCESS",
"data": null
}Error Responses
Unauthorized 401
{
"success": false,
"code": "4010",
"message": "Invalid or expired token"
}Notes
- Returns
data: nullon success. - Only PENDING invitations can be cancelled; already accepted/declined/expired invitations cannot be cancelled.
- Requires
workspace:invitation:writepermission.