---
title: "Invite users"
method: POST
path: "/users.invite"
tags: ["Users"]
---

# Invite users

`POST /users.invite`

## Request body

- object
  - `invites` Invite[], required
    - `name` string — The full name of the user being invited
    - `email` string — The email address to invite
    - `role` 'admin' | 'member' | 'viewer' | 'guest'

## Response `200`

OK

- object
  - `data` object
    - `sent` Invite[]
      - `name` string — The full name of the user being invited
      - `email` string — The email address to invite
      - `role` 'admin' | 'member' | 'viewer' | 'guest'
    - `users` User[]
      - `id` string, uuid — Unique identifier for the object.
      - `name` string — The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
      - `avatarUrl` string, uri — The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
      - `email` string, email — The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
      - `role` 'admin' | 'member' | 'viewer' | 'guest'
      - `isSuspended` boolean — Whether this user has been suspended.
      - `lastActiveAt` string, date-time — The last time this user made an API request, this value is updated at most every 5 minutes.
      - `createdAt` string, date-time — The date and time that this user first signed in or was invited as a guest.

## Other responses

- `401` — The API key is missing or otherwise invalid.
- `403` — The current API key is not authorized to perform this action.
- `429` — The request was rate limited.

## Changes

- **2024-10-18** `fdf2ec9c9df4` — 1 info
  - added the non-success response with the status `429`
- **2024-07-06** `7b33b538cd7d` — 2 warning, 7 info
  - removed the optional property `sent` from the response with the `200` status
  - removed the optional property `users` from the response with the `200` status
  - added the optional property `data` to the response with the `200` status
  - added the optional property `data` to the response with the `401` status
  - …5 more

[Change history](https://skmtc.dev/defaulr/apis/outline-api/changes/users.invite/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) · [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/defaulr/outline-api/revisions/fdf2ec9c9df4/schema)