outline icon

outline

Interact with outline API

Actions107

Users → Users Invite

AI-generated

Summary

Invite users to an Outline workspace

Inputs

  • invites (required) — Array of invite objects to create. Input will be split into batches per requestOptions configuration if batching is enabled.
  • requestOptions — Configuration for request throttling and options.
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
  • proxy — HTTP proxy to use. If authentication is required it can be defined as: http://username:password@myproxy:3128
  • timeout — Time in ms to wait for the server to send response headers before aborting the request

Output shape

main

Returns the Outline API response confirming user invite creation.

Examples

Example 1: Invite single user with batching disabled

Set invites to a JSON array containing one user object, leave requestOptions batching at default (batchSize: 50, batchInterval: 1000), and use default timeout.

Links

Discussion