Invite users

Send email invitations to one or more users to join the workspace. Invitations include a link to create an account and join the workspace.

post/users.invite

Request

Base URL
https://app.getoutline.com/api
URL
https://app.getoutline.com/api/users.invite
Auth
- HTTP bearer
- or OAuth 2
  Authorization code: https://app.getoutline.com/oauth/authorize
  Token URL: https://app.getoutline.com/oauth/token scopes: read, write

suppressEmailboolean

If true, the invitation emails will not be sent to the invited users. Defaults to false.

{
  "data": {
    "users": [
      {
        "name": "Jane Doe"
      }
    ]
  }
}

Aug 12, 20269a99ee93e11d Revision changes
- info
  added the optional property /// to the response with the status
May 30, 2026304cd065561b Revision changes
- breaking
  the response property /// became nullable for the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status