Skip to main content
POST
/
management
/
v1
/
projects
/
users
/
invite
Invite a New User
curl --request POST \
  --url https://{cluster}.voucherify.io/management/v1/projects/users/invite \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>' \
  --data '{
  "email": "alex.doe@your-domain-name.com",
  "first_name": "Alex",
  "last_name": "Doe",
  "projects": {
    "proj_ExPr0jID": "USER",
    "proj_ExPr0jId": "role_XyZ7aB9cD2eF4gH1iJ0kL5mN6oP8qR3s"
  }
}'
This response does not have an example.

Authorizations

​
X-Management-Id
string
header
required
​
X-Management-Token
string
header
required

Body

application/json

Defines the details of the invitation, the project, and roles to which the user will be assigned.

Request body schema for POST /management/v1/projects/users/invite.

​
email
string
required

Email address to which the invitation will be sent. Must be a valid email address.

Example:

"alex.doe@your-domain-name.com"

​
first_name
string
required

First name of the person who will receive the invitation. The name will be used in the user profile.

Example:

"Alex"

​
last_name
string
required

Last name of the person who will receive the invitation. The name will be used in the user profile.

Example:

"Doe"

​
projects
object
required

In the key, provide the project ID to which the new user will be assigned. In the value, provide the role which the user will have in the project. The predefined Voucherify roles are: ADMIN, USER, VIEWER, MERCHANT, USER_RESTRICTED (for the Areas and Stores, an Enterprise feature). Send a custom role ID (Enterprise feature) to assign a custom role. To find the custom role ID: If you are an admin, go to Voucherify Dashboard, Team settings, and Roles tab. Click on a custom role. The custom role ID is in the URL in the format role_XyZ7aB9cD2eF4gH1iJ0kL5mN6oP8qR3s.

Example:
{
  "proj_ExPr0jID": "USER",
  "proj_ExPr0jId": "role_XyZ7aB9cD2eF4gH1iJ0kL5mN6oP8qR3s"
}

Response

Returns no content if the invitation has been sent successfully.

⌘I