Files
directus/packages/spec/specs/paths/users/user-invite.yaml
2020-10-12 14:05:27 -04:00

32 lines
929 B
YAML

post:
description:
Invites one or more users to this project. It creates a user with an
invited status, and then sends an email to the user with instructions on how to
activate their account.
operationId: invite
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
description: Email address or array of email addresses of the to-be-invited user(s).
type: string
responses:
"200":
description: Successful request
content:
application/json:
schema:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Users"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
tags:
- Users