# Invite a member

URL: https://heaven.dev/docs/reference/organizations/member-add
Updated: 2026-11-21

Invite someone to an organization with a role, command permissions and optional team membership. The invitation expires after seven days. Membership starts when the recipient accepts.

`POST /v1/organization/modify`

## Parameters

- `user` (string, required): The person to invite, by email address or user ID.
- `role` (string): Role the recipient receives on acceptance. `user` is the default. `admin` grants organization administration. `billing_owner` transfers billing ownership and can be offered only by the billing owner.
- `grants` (string[]): Additional management command to give the member across the organization. Give the command name as listed in `help`.
- `withholds` (string[]): Management command to exclude from the role. Give the command name as listed in `help`.
- `teams` (string[]): A team the person joins when accepting the invitation.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): An invitation awaiting the recipient's acceptance.
  - `grant_scope` (string): Resources on which the invited command grants apply, when grants were included. May be omitted.
  - `invite_id` (string, always present): Invitation ID.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `payment_required` | 402 | Payment or credit is required. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- CLI: `heaven login` with `HEAVEN_API_KEY` unset. MCP: Heaven sign-in. cURL: `HEAVEN_SIGN_IN_KEY` from approved device sign-in (`POST /v1/auth/create`).
- A key limited to a command list cannot run this command.

## Examples

```sh tab="heaven CLI"
heaven organization member add USER [ROLE]
  [--grant GRANT ...]
  [--withhold WITHHOLD ...]
  [--team TEAM ...]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev organization member add USER [ROLE]
  [--grant GRANT ...]
  [--withhold WITHHOLD ...]
  [--team TEAM ...]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/organization/modify \
  -H "Authorization: Bearer $HEAVEN_SIGN_IN_KEY" \
  --json '{"action": "member add", "user": "ana@example.com", "role": "user", "grants": ["pool start", "pool stop"], "teams": ["web"], "organization": "acme"}'
```

```json tab="MCP"
{ "tool": "organization_member_add",
  "arguments": { "user": "ana@example.com", "role": "user", "grants": ["pool start", "pool stop"], "teams": ["web"], "organization": "acme" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "grant_scope": "organization",
    "invite_id": "030d4e6a-8560-41a4-a98a-94fb0216a804"
  }
}
```
