---
title: "createOrgInvitation"
description: "Invite someone to the organization"
canonical: "https://pgbeam.com/docs/ts-sdk/account/createOrgInvitation"
last-updated: "2026-10-22T11:48:14.000Z"
---

# createOrgInvitation

> Invite someone to the organization

URL: https://pgbeam.com/docs/ts-sdk/account/createOrgInvitation

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Creates an invitation and emails it. Inviting an address that already has a pending invitation returns a conflict rather than a second invitation. `owner` cannot be invited: ownership transfer is a separate, higher-privilege flow.

## Usage

```typescript
const result = await api.account.createOrgInvitation({
  pathParams: { org_id: "org_abc123" },
  body: {
    email: "engineer@example.com",
  },
});
```

## Parameters

| Parameter         | Type                | Required | Description                                                                                                                                                                            |
| ----------------- | ------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pathParams.org_id | `string`            | Yes      | Unique organization identifier.                                                                                                                                                        |
| body.email        | `string`            | Yes      | Address to invite.                                                                                                                                                                     |
| body.role         | `AssignableOrgRole` | No       | A role that can be assigned through the member API. This is `OrgRole` without `owner`: ownership is transferred through a separate flow, so requesting it here is rejected with a 400. |

## Response

`Promise<OrgInvitation>`: the invitation was created.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.account.createOrgInvitation({
  pathParams: { org_id: "org_abc123" },
  body: {
    email: "engineer@example.com",
  },
});
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                                                           |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status.                                 |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                                                               |
| 409    | The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                                                                                                                                                                                                                               |