Create a new user

post /companies/{companyId}/users

Creates the user for the companyId identified in the path.

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

  • Management API—Users read and write

Endpoint destination URL{companyId}/users
Click to copy

Path parameters

companyId string Required

The unique identifier of the company account.

Request parameters

accountGroups array [string]

The list of account groups associated with this user.

associatedMerchantAccounts array [string]

The list of merchant accounts associated with this user.

email string Required

The email address of the user.

name object Required
Min length: 1 Max length: 80

The user's full name.

Allowed length: 1—80 characters.

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.

username string Required
Min length: 1 Max length: 255

The user's email address that will be their username. Must be the same as the one in the email field.

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
  • 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
  • Request
  • Click to copy
  • Response
  • Click to copy