Management

Invite a New User

Sends an invitation to an email address that has not been used yet as a Voucherify user login.

You can specify the projects to which the invited user will be assigned and define their roles.

post/management/v1/projects/users/invite

Request

Base URL
https://api.voucherify.io
URL
https://api.voucherify.io/management/v1/projects/users/invite
Auth
API key in header X-Management-Id and API key in header X-Management-Token

Request body

emailstring required

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

first_namestring required

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

last_namestring required

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

projectsobject 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 request

{
  "email": "alex.doe@your-domain-name.com",
  "first_name": "Alex",
  "last_name": "Doe",
  "projects": {
    "proj_ExPr0jID": "USER",
    "proj_ExPr0jId": "role_XyZ7aB9cD2eF4gH1iJ0kL5mN6oP8qR3s"
  }
}

Response

Returns no content if the invitation has been sent successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.