VOvoucherifyio
Management

Assign User

Assigns a user to a given project. The user must be an existing user in Voucherify.

🚧 Correct Use of Data

To avoid errors, use the "role" key with either "id" or "login" keys.

post/management/v1/projects/{projectId}/users

Request

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

Request body

idstring

The unique identifier of the user who will be assigned to the project. It can be found in Team Settings > Team > Edit member. Required with the role string.

Do not use with the login string.

loginstring

The login data of the user who will be assigned to the project. Required with the role string.

Do not use with the id string.

rolestring required

The role of the user to be added. It can be one of the following predefined roles: ADMIN, USER, VIEWER, MERCHANT, or an ID of a custom role.

Response

Returns the details about the user assigned to the project.

idstring required

The unique identifier of the user who has been assigned to the project.

loginstring required

The login data of the user who has been assigned to the project.

emailstring required

The email address of the user who has been assigned to the project.

first_namestring required

The first name of the user who has been assigned to the project.

last_namestring required

The last name of the user who has been assigned to the project.

projectsobject required

Lists key-value pairs, where the key is the project to which the user is assigned. The value is the role assigned in a given project. The predefined Voucherify roles are: ADMIN, USER, VIEWER, MERCHANT, USER_RESTRICTED (for the Areas and Stores, an Enterprise feature).

is_ownerboolean required

Determines if the user is the owner for the organization in Voucherify.

Changes

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