---
title: "SDK: invitations"
description: "The invitations methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: invitations

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `invitations` area has 4 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## invitationsAccept

Accept a team invitation (a person does this)

- Request: `POST` on `/v1/invitations/accept`

```ts
invitationsAccept(args: { body: AcceptInvitationRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

## invitationsCreate

Invite someone to the team (policy class)

- Request: `POST` on `/v1/tenants/{tenantId}/invitations`
- Needs an approval for agents: class `policy_change`

```ts
invitationsCreate(args: { tenantId: string; body: CreateInvitationRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

## invitationsList

List open invitations

- Request: `GET` on `/v1/tenants/{tenantId}/invitations`

```ts
invitationsList(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## invitationsRevoke

Revoke an invitation

- Request: `DELETE` on `/v1/tenants/{tenantId}/invitations/{invitationId}`

```ts
invitationsRevoke(args: { tenantId: string; invitationId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

Source: https://docs.overlane.app/sdk/invitations/index.mdx