Create multiple users (v5 and above)

Please read this page before using this resource.

Create multiple new users using a HTTP POST request. This is similar to adding a single user, but instead you must list multiple users in an array.

Resource URL:

https://<instance_name>.fuseuniversal.com/api/v5.0/manage/users

Request

Request header parameters

Authorisation is required.

Request parameters

Mandatory parameters required to create a new user include username, password and password_confirmation.

Mandatory parameters as well as all the optional parameters are described in the User Profile Fields guide.

Use the request examples on this page as a reference.

The request example does not include all possible parameters.

Settings and profile options will vary depending on requirements.

Response

The response for this API endpoint contains the user registration that was created. Security-sensitive fields may not be returned in the response.

The Fuse user ID is the UID automatically generated by the system when a user is created. This cannot be changed. All other user attributes can be changed.

Please refer to the Response codes guide for more information.

Example request

Request URL example

https://<instance_name>.fuseuniversal.com/api/v5.0/manage/users

Request body

JSON

{
    "users": [
        {
            "username": "{{username}}",
            "password_confirmation": "Password1234!",
            "password": "Password1234!",
            "email": "{{email}}",
            "accessibility_theme": "theme_v1",
            "manager_ids": "{{fuseid of manager}}",
            "profile": {
                "First Name": "{{first Name}}",
                "Last Name": "{{last Name}}",
                "Department": "{{department}}",
                "Postition": {{position}},
                "Manager Name": {{manager Name}},
                "Functional Role": "{{Role}}",
                "Employee ID": {{ID}},
                "Start Date": "{{YYYY-MM-DD}}",
                "Tenure": {{Tenure}},
                "Is Manager?": {{Yes}}
            },
            "settings": {
                "default_locale": "en-UK",
                "time_zone": "(GMT+00:00) London"
            }
        },
        {
            "username": "{{username}}",
            "password_confirmation": "Password1234!",
            "password": "Password1234!",
            "email": "{{email}}",
            "accessibility_theme": "theme_v1",
            "manager_ids": "{{fuseid of manager}}",
            "profile": {
                "First Name": "{{first Name}}",
                "Last Name": "{{last Name}}",
                "Department": "{{department}}",
                "Postition": {{position}},
                "Manager Name": {{manager Name}},
                "Functional Role": "{{Role}}",
                "Employee ID": {{ID}},
                "Start Date": "{{YYYY-MM-DD}}",
                "Tenure": {{Tenure}},
                "Is Manager?": {{Yes}}
            },
            "settings": {
                "default_locale": "en-UK",
                "time_zone": "(GMT+00:00) London"
            }
        },
        {
            "username": "{{username}}",
            "password_confirmation": "Password1234!",
            "password": "Password1234!",
            "email": "{{email}}",
            "accessibility_theme": "theme_v1",
            "manager_ids": "{{fuseid of manager}}",
            "profile": {
                "First Name": "{{first Name}}",
                "Last Name": "{{last Name}}",
                "Department": "{{department}}",
                "Postition": {{position}},
                "Manager Name": {{manager Name}},
                "Functional Role": "{{Role}}",
                "Employee ID": {{ID}},
                "Start Date": "{{YYYY-MM-DD}}",
                "Tenure": {{Tenure}},
                "Is Manager?": {{Yes}}
            },
            "settings": {
                "default_locale": "en-UK",
                "time_zone": "(GMT+00:00) London"
            }
        }
    ]
}