Invite User

Invite a New User

POST/management/v1/projects/users/invite

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the Invite User action (under Management).
Fill in the fields below, then reference the result from later steps as {{inviteUser.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

emailstring

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

first_namestring

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

last_namestring

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

projectsobject

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`.

json

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

Response

Returns 204 with a any. Read it in later steps with {{inviteUser.response.data.<field>}}.

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?