Create an Invite

Prod Env

POST

/admin/invites

Create an Invite. This will generate a token associated with the invite and trigger an invite.created event. If you have a Notification Provider installed that handles this event, a notification should be sent to the email associated with the invite to allow them to accept the invite.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST '{{baseURL}}/admin/invites' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": "user@example.com",
    "role": "admin"
}'

Response Example

200 - Example 1

{}

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2025-07-23 05:41:28

Lists Invites

Delete an Invite