A specific invite within a given workspace
https://api.xata.io/workspaces/workspace_id/invites/invite_idThis endpoint enables working with a given invite.
Expected parameters
| Name | Description | In | Required | Schema |
|---|---|---|---|---|
workspace_id | Workspace ID | path | ✅ | string |
invite_id | Invite identifier | path | ✅ | string |
Updates an Existing Invite
PATCHhttps://api.xata.io/workspaces/workspace_id/invites/invite_idThis 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";type UpdateWorkspaceMemberInvite = {
id?: string;
message: string;
};{
"message": "invalid API key"
}{
"message": "invalid API key"
}type UpdateWorkspaceMemberInvite = {
id?: string;
message: string;
};type UpdateWorkspaceMemberInvite = {
id?: string;
message: string;
};type UpdateWorkspaceMemberInvite = void;Deletes an Invite
DELETEhttps://api.xata.io/workspaces/workspace_id/invites/invite_idThis operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.
Responses
type CancelWorkspaceMemberInvite = void;type CancelWorkspaceMemberInvite = {
id?: string;
message: string;
};{
"message": "invalid API key"
}{
"message": "invalid API key"
}type CancelWorkspaceMemberInvite = {
id?: string;
message: string;
};type CancelWorkspaceMemberInvite = void;