Page tree
Skip to end of metadata
Go to start of metadata

Method: addUser

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles

Department Administrators and users with a custom role can add users only to the departments they manage and their sub-departments.





credentials (required)credentialsRead the description of the Credentials object.
email (optional)stringEmail of the new user.
login (required)stringLogin of the new user.
password (optional)stringPassword of the new user. 
departmentId (required)stringDepartment ID the user will be added to.
sendLoginEmail (optional, default: true)boolParameter that determines whether an email is sent to the added user.
invitationMessage (optional)stringText of an invitation message in the email.
role (required)string

If you assign one of the standard roles to the user (apart from Account Owner and Publisher), set one of the following values to the role parameter:

  • learner
  • department_administrator
  • administrator

If you assign one of the custom roles to the users, set the custom value to the role parameter. 

roleId (required if the user role is Publisher or a custom role)stringThe roleId parameter is used, if you assign one of the custom roles or the Publisher role to the user.

manageableDepartmentIds (required if the user's role is Department Administrator, Publisher, or a custom role)


An array with the IDs of the departments the user will manage.

groups (optional)string[]An array with the IDs of the groups the user will be added to.

If in the account there are required user profile fields (apart from the fields of the 'Country' format), they should be also put into the request.

Return Value

After the request has been completed, the system returns an object with the following properties:




userIdstringID of the added user.

 Possible Errors



User with the same email is already registered.A user with the specified e-mail address already exists.
User with the same login is already registered.A user with the specified e-mail address already exists.
Number of user accounts is exceededA user hasn't been added because the number of user accounts supported by your subscription plan has been exceeded.
Permission DeniedAn authorized user does not have enough permissions to handle the operation. For example, Department Administrator can't add users to a department they don't manage.
Wrong parametersSome of the sent parameters are incorrect.

Sample Call

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV=""

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV=""
  • No labels