A specific invite within a given workspace

https://api.xata.io/workspaces/workspace_id/invites/invite_id

This endpoint enables working with a given invite.

Expected parameters

NameDescriptionInRequiredSchema
workspace_id

Workspace ID

pathstring
invite_id

Invite identifier

pathstring

Updates an Existing Invite

PATCH
https://api.xata.io/workspaces/workspace_id/invites/invite_id

This operation provides a way to update an existing invite. Updates are performed in-place; they do not change the invite link, the expiry time, nor do they re-notify the recipient of the invite.

Request Body Type Definition

type UpdateWorkspaceMemberInvite = {
    role: Role;
};
 
type Role = "owner" | "maintainer";

Responses

type UpdateWorkspaceMemberInvite = {
    inviteId: InviteID;
    /**
     * @format email
     */
    email: string;
    /**
     * @format date-time
     */
    expires: string;
    role: Role;
};
 
/**
 * @pattern [a-zA-Z0-9]+
 */
type InviteID = string;
 
type Role = "owner" | "maintainer";

Deletes an Invite

DELETE
https://api.xata.io/workspaces/workspace_id/invites/invite_id

This operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.

Responses

type CancelWorkspaceMemberInvite = void;