Xata

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_idWorkspace IDpath✅string
invite_idInvite identifierpath✅string

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

1
2
3
4
5
type UpdateWorkspaceMemberInvite = {
    role: Role;
};

type Role = "owner" | "maintainer";
Status CodeDescriptionExample Response/Type Definition
200Updated successfully.
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";
400Bad Request
type UpdateWorkspaceMemberInvite = {
    id?: string;
    message: string;
};
401Authentication Error
{
  "message": "invalid API key"
}
403Authentication Error
{
  "message": "invalid API key"
}
404Example response
type UpdateWorkspaceMemberInvite = {
    id?: string;
    message: string;
};
422Example response
type UpdateWorkspaceMemberInvite = {
    id?: string;
    message: string;
};
5XXUnexpected Error

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.

Status CodeDescriptionExample Response/Type Definition
204No Content
400Bad Request
type CancelWorkspaceMemberInvite = {
    id?: string;
    message: string;
};
401Authentication Error
{
  "message": "invalid API key"
}
403Authentication Error
{
  "message": "invalid API key"
}
404Example response
type CancelWorkspaceMemberInvite = {
    id?: string;
    message: string;
};
5XXUnexpected Error