Skip to content

Cancel Invitation

POST/web/v1/workspaces/{workspaceBizId}/invitations/cancel JWT

Cancels a pending workspace invitation. Only PENDING invitations can be cancelled.

Required Headers

HeaderExample ValueDescription
Content-Typeapplication/jsonRequest content type
Acceptapplication/jsonExpected response type
X-Client-HashClient device fingerprint
Accept-Languageen, zh, zh-Hant, ja, viResponse language (default: en)
AuthorizationBearerJWT access token
X-Workspace-IdTarget workspace ID

Request Parameters

NameTypeRequiredInDescription
workspaceBizIdStringRequiredpathBusiness 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: null on success.
  • Only PENDING invitations can be cancelled; already accepted/declined/expired invitations cannot be cancelled.
  • Requires workspace:invitation:write permission.

SlaunchX Internal Documentation