---
title: "Invite a member."
method: POST
path: "/v1/org/members/invite"
tags: ["org"]
---

# Invite a member.

`POST /v1/org/members/invite`

## Request

- Base URL: `https://api.smolmachines.com`
- URL: `https://api.smolmachines.com/v1/org/members/invite`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/smolmachines/apis/smolfleet-api/docs/v1/org/members/invite/post.ts> (a function with typed inputs; its response is checked against the schema)

Emails an invitation to join the organization with a given role. Requires a user login, not an API key, and the `members:write` scope (owner or admin).

## Request body

- InviteMemberRequest: Body of `POST /v1/org/members/invite`, declared here so it reaches the client spec.
  - `email` string, required: The address to invite, matched case-insensitively against the IdP's verified address.
  - `role` string, required: `owner`, `admin` or `member`.

## Response `201`

Invitation recorded and, with a mail provider configured, sent; the body carries the accept link, the only readable copy of the token, which lapses in seven days.

- InviteResult: Result of inviting a member: the accept link, which comes back even with no email provider configured (the admin can copy and share it directly).
  - `emailSent` boolean, required: Whether the link was handed to a mailer; false on a deployment with none.
  - `invitationUrl` string, nullable: The accept link, carrying the only readable copy of the token.

## Other responses

- `400`: Not an email address, or a role other than owner, admin or member
- `401`: Missing or invalid API key
- `402`: The organization has no payment method on file
- `403`: Inviting is an owner or admin action, or the caller is an API key
- `409`: That address already has an outstanding invitation to this organization, or is already on its roster
- `422`: An individual account, not an organization
- `429`: Rate limited; retry after the Retry-After header
- `500`: Internal error

## Changes

- **2026-10-16** `bc31fc04a568`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smolmachines/apis/smolfleet-api/changes/v1/org/members/invite/post.md)

---

[API](https://skmtc.dev/smolmachines/apis/smolfleet-api.md) - [All operations](https://skmtc.dev/smolmachines/apis/smolfleet-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smolmachines/apis/smolfleet-api/revisions/bc31fc04a568?raw)
