Revoke a pending workspace invite
Marks the invite revoked so its token can no longer be redeemed, cancels the queued invitation email, and returns the resulting invite. Requires `members:invite`. An unknown invite is not found and one that is no longer pending conflicts.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/workspaces/string/invites/string"{ "data": { "id": "string", "workspaceId": "string", "email": "string", "role": "owner", "status": "pending", "invitedByUserId": "string", "acceptedByUserId": "string", "expiresAt": "string", "createdAt": "string", "updatedAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Change a pending invite's role or expiry
Updates the role and/or expiry of an invite that is still pending. Requires `members:invite`, and only owners may move an invite to or from the owner role. An unknown invite is not found, an invite that has already been accepted or revoked conflicts, and raising a viewer invite to an editor role must fit within the plan's editor seats.
Preview a workspace invite from its token
Resolves an invite token to the workspace name, icon, accent color, invited email, role, and status so the sign-in screen can show what is being joined. No authentication; the token in the path is the credential. A pending invite past its expiry is reported with status `expired`, and an unknown token is not found.