---
title: "Invite web user"
description: "Create a new web user and send a registration email."
url: "https://docs.adyen.com/account-management-api/manage-user-accounts/invite-web-users"
source_url: "https://docs.adyen.com/account-management-api/manage-user-accounts/invite-web-users.md"
canonical: "https://docs.adyen.com/account-management-api/manage-user-accounts/invite-web-users"
last_modified: "2019-12-13T10:04:00+01:00"
language: "en"
---
# Invite web user
Create a new web user and send a registration email.
[View source](/account-management-api/manage-user-accounts/invite-web-users.md)
Use the `/inviteWebUser` endpoint to create a user and send an email to invite them to register.
After you submit the request, the user will receive an email from Adyen, containing a one-time use link to a page where they create their own password to complete the registration process. The link is valid within 24 hours. If the link has already expired and the user has not yet completed the registration, inform them to contact their Admin and ask to send a new invitation email.
The endpoint requires at least one `merchantCode` and one `role`. After the user completes the registration, their account will be associated with the merchant codes provided in the request.
## Request parameters
To invite a new web user, make a POST `/inviteWebUser` request specifying the following parameters:
| Name | | Type | Required | Description |
| ------------------- | -------------- | ------ | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email` | | String |  | The email address associated with the user account. |
| `merchantCodes` | | Array |  | An array of merchant code strings. A merchant code string holds a value to identify a merchant.Format:- Either: `MerchantAccount.Merchant_Code`
- Or: `Merchant_Code` |
| `accountGroupCodes` | | Array |  | An array of [account group names](/account/account-structure#account-groups). For example: `["groupEU", "groupUS"]`. |
| `timeZoneCode` | | String |  | The time zone associated to the user account profile.If you do not specify any value, the active user's time zone settings are used instead. |
| `userName` | | String |  | A user name string holds the user account display name. It can include:- Digits: *0-9*
- Letters *a-z*, *A-Z*
- Special characters: "*.*" (dot), "*-*" (hyphen), "*\_*" (underscore)* * |
| `name` | | Object |  | A container object for personal data. This object contains:- `firstName`
-
- `lastName` |
| | \|-`firstName` | String |  | The first name/given name of the user.- Max. length: 80 characters |
| | \|-`lastName` | String |  | The last name/family name of the user.- Max. length: 80 characters |
| `roles` | | Array |  | A container object for types of role for the account user.- `RoleType` |
| | `RoleType` | Enum |  | It defines the type of role assigned to the user account. Some examples of roles are:- `Merchant_standard_role`
- `Merchant_manage_payments`
- `Merchant_Report_role`
- `Merchant_dispute_management`
- `Merchant_technical_integrator`
- `Merchant_View_Risk_Results_role`
- `Merchant_view_risk_settings`
- `Merchant_change_risk_settings`
- `Merchant_allowed_own_password_reset` |
## Response parameters
The response contains the user name and a `pspReference`.
If any issues occur during the process, the call returns one or more warning or error messages. The user is not created and no username is returned in the response.
| Name | Type | Returned by default | Description |
| -------------- | ------ | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `userName` | String |  | The user name assigned to the newly created account. |
| `pspReference` | String |  | Unique identifier for the request. |
| `warnings` | Array |  | String array containing one or more warning messages. Returned when the request is not correctly processed. |
| `errors` | Array |  | String array containing one or more warning messages. Returned when the request is not correctly processed. |
## Examples
### Request
#### JSON
```json
{
"email":"test@test.nl",
"merchantCodes":[
"MerchantAccount.TestMerchant"
],
"name":{
"firstName":"Jane",
"lastName":"Hopper"
},
"roles": [
"Merchant_standard_role",
"Merchant_allowed_own_password_reset"
],
"timeZoneCode":"UTC",
"userName":"testUser"
}
```
#### Soap
```xml
test@test.nl
MerchantAccount.TestMerchant
Merchant_standard_role
Merchant_allowed_own_password_reset
Jane
Hopper
UTC
testUser
```
### Response
#### JSON
```json
{
"pspReference":"9914526950450289",
"userName": "testUser"
}
```
#### Soap
```xml
9914526950450289
testUser
```
### Response in case of an error
#### JSON
```json
{
"pspReference":"9914368689030052",
"errors":[
"8_008 lacks permission to merchant 'TestMerchant'"
]
}
```
#### Soap
```xml
8_008 lacks permission to merchant 'TestMerchant'
9914368689030052
```