Update a user

patch /merchants/{merchantId}/users/{userId}

Updates user details for the userId and the merchantId specified in the path.

To make this request, your API credential must have the following role:

  • Management APIā€”Users read and write

Endpoint destination URL

Click to copy

Path parameters

userId string Required

Unique identifier of the user.

merchantId string Required

Unique identifier of the merchant.

Request parameters

accountGroups array [string]

The list of account groups associated with this user.

active boolean

Sets the status of the user to active (true) or inactive (false).

email string

The email address of the user.

name object
Min length: 1 Max length: 80

The user's full name.

roles array [string]

The list of roles for this user.

timeZoneCode string

The tz database name of the time zone of the user. For example, Europe/Amsterdam.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 204 - No Content

    The request has been successfully processed, but there is no additional content.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less