Skip to main content
PUT
/
management
/
v1
/
projects
/
{projectId}
/
users
/
{userId}
Update User
curl --request PUT \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/users/{userId} \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>' \
  --data '{
  "role": "<string>"
}'
{
  "id": "user_FgEAjOV6RiObJdy36sYynXdqZNiA5gjM",
  "login": "name@youremaildomain.com",
  "email": "name@youremaildomain.com",
  "first_name": "Sammy",
  "last_name": "Jones",
  "projects": {
    "proj_9KeAhZB1": "USER",
    "proj_npnFzPr9": "USER",
    "proj_pEP3NO9s": "USER",
    "proj_zsPdrUIw": "ADMIN"
  },
  "is_owner": false
}

Authorizations

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

Path Parameters

​
projectId
string
required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

​
userId
string
required

Provide the unique identifier of the user. Alternatively, provide the user's login.

Example:

"user_v18mvPOjOXE5733eO4cAz8k1pn492wKK"

Body

application/json

Defines the user's new role.

​
role
string
required

The role of the user to be added. It can be a custom role or one of 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.

Details about the user assigned to the project. Details about the user.

​
id
string
required

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

​
login
string
required

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

​
email
string
required

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

​
first_name
string
required

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

​
last_name
string
required

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

​
projects
object
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_owner
boolean
required

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

⌘I