Create an Invite

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

Body Params application/json

Example

{
    "user": "user@example.com",
    "role": "admin"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200OK

application/json

Body

Example

{}

🟠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 2023-10-08 12:50:29

Lists Invites

Delete an Invite