Xata

Accept an Invite

https://api.xata.io/workspaces/workspace_id/invites/invite_key/accept

This RPC-style endpoint accepts a given invite to join a workspace.

Expected Parameters

NameDescriptionInRequiredSchema
workspace_idWorkspace IDpath✅string
invite_keyInvite Key (secret) for the invited userpath✅string

Accept the Invitation to Join a Workspace

POST
https://api.xata.io/workspaces/workspace_id/invites/invite_key/accept

Accept the invitation to join a workspace. If the operation succeeds the user will be a member of the workspace

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