Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Create multiple users

Please read this page before using this resource.

Create multiple new user users with a HTTP POST request, similar to adding a single user, but instead listing multiple users in an array.

Resource URL:

https://<instance_name>.fuseuniversal.com/api/v4.3/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 reference guide.

Info

Please use Use the request example examples on this page as a reference.

Note

The request example doesn’t include all the possible parameters.

Info

Settings and Profile options will vary depending on the requirement.

Response

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

Note

The Fuse userID is the UID automatically generated by the system on user creation. It cannot be changed. All other user attributes can be changed.

Info

Please refer to the Response Codes page for more information.

EXAMPLE REQUEST #1

REQUEST URL EXAMPLE

https://<instance_name>.fuseuniversal.com/api/v4.3/manage/users?auth_token=<valid_auth_token>

REQUEST BODY

Code Block
languagejson
{
    "users": [
        {
            "username": "testuser1",
            "password_confirmation": "Password1234!",
            "password": "Password1234!",
            "email": "testuser1@net.com",
            "role": "user",
            "profile": {
                "FirstName": "test1",
                "LastName": "user1"
            },
            "plain_text_emails": true,
            "hidden_from_leaderboard": true,
            "accessibility_enabled": false,
            "accessibility_theme": "theme_v1",
            "settings": {
                "default_locale": "en",
                "instant_emails": true,
                "send_instant_for_comment": true,
                "send_instant_for_share": true,
                "send_instant_for_like": true,
                "send_instant_for_revision": true,
                "digest_emails": "on",
                "notification_block_in_digest": true
            }
        },
        {
            "username": "testuser2",
            "password_confirmation": "Password1234@",
            "password": "Password1234@",
            "email": "testuser2@net.com",
            "role": "user",
            "profile": {
                "FirstName": "test2",
                "LastName": "user2"
            },
            "plain_text_emails": true,
            "hidden_from_leaderboard": true,
            "accessibility_enabled": false,
            "accessibility_theme": "theme_v1",
            "settings": {
                "default_locale": "en",
                "instant_emails": true,
                "send_instant_for_comment": true,
                "send_instant_for_share": true,
                "send_instant_for_like": true,
                "send_instant_for_revision": true,
                "digest_emails": "on",
                "notification_block_in_digest": true
            }
        },
        {
            "username": "testuser3",
            "password_confirmation": "Password1234#",
            "password": "Password1234#",
            "email": "testuser3@net.com",
            "role": "user",
            "profile": {
                "FirstName": "test3",
                "LastName": "user3"
            },
            "plain_text_emails": true,
            "hidden_from_leaderboard": true,
            "accessibility_enabled": false,
            "accessibility_theme": "theme_v1",
            "settings": {
                "default_locale": "en",
                "instant_emails": true,
                "send_instant_for_comment": true,
                "send_instant_for_share": true,
                "send_instant_for_like": true,
                "send_instant_for_revision": true,
                "digest_emails": "on",
                "notification_block_in_digest": true
            }
        }
    ]
}