latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Delete Invitation

Deletes a workspace invitation. Only admins can delete invitations.

post/api/v1/workspaces/invitations/delete

Request body

workspace_idinteger required

ID of the workspace containing the invitation.

user_emailstring required

Email address of the invited user.

Example request

{
  "workspace_id": 123456,
  "user_email": "teammate@example.com"
}

Response

Successful Response

inviter_idstring required

ID of the user user who sent the invitation

user_emailstring required

The invited person's email.

workspace_idstring required

ID of the workspace

role'ADMIN' | 'MEMBER' | 'GUEST' required

Role of the user inside the workspace

idstring

The ID of the invitation

Example response

{
  "inviter_id": "1029384756",
  "user_email": "foo@example.com",
  "workspace_id": "12345",
  "id": "234"
}