Manage Users

Users are created in the User Management view or on-the-fly when an action is logged for a user ID. If an action is logged for a user ID that doesn't exist, a new record is created and all subsequent action data is associated with the new record. User authentication is managed using your site's security.

Create a User

1. Open Nitro Studio > Activity > Users.
2. Click New.
3. Set user properties:

Field	Description
User ID	The user's gamification ID. The user ID is used to make API calls, so choose an identifier that you always have access to wherever you need to make a call. This may be the user's GUID, username, email, or other identifier.
First Name	The user's first name. The name is stored as a preference.
Last Name	The user's last name. The name is stored as a preference.
user image	The user's photo/avatar image. The image is stored in the userPhotoUrl preference.

4. Click Save or Save & add another.

Add User Details

If a user is created by logging an action, you can add user details such as first name, last name, or other custom data after the user is created using preferences. User preferences are managed in the User Management view, via data import, or with the PUT /users/{userId} method.

Change a User's Point Balance

An administrator can manually edit a user's point balance using Nitro Studio or APIs.

Scenario	Method
Single user Any point category	Use the User Management view > Balances tab and change the balance of the appropriate point category.
Multiple users Any point category	Use data import to upload a file of users and credits or debits. Use POST /users/{userId}/point-transactions to add points to the user's balance or PUT /users/{userId}/point-balance to set the user's balance to some amount.

Delete a User

Deleting a user removes all their data and accumulated rewards. You can delete a single user in the User Management view by clicking Delete () on the user's detail page. To delete all users, an account reset or new API Key is required. Contact Bunchball support to make this request.

If you have a mission limited to a number of missions or points and you delete a user that earned points for completing that mission, the deleted user's points are not added back to the mission limit threshold.

Note: If you are deleting anonymous users because you no longer want to have them in your program, you will also need to find and remove where actions are being logged for the anonymous users. Removing the actions will stop additional anonymous users from being created.

Change a User ID

Contact Bunchball Support if you need to change a user ID. Bunchball will complete the following steps. Show me

When changing a user ID, the user’s new ID cannot already exist in Nitro. If the ID does exist, extra steps are required to change the ID.

Step 1

1. Open Nitro Studio > Tools > API Explorer.
2. Open the user.modifyUserId method.
3. In the oldUserId field, enter the user's existing ID (e.g. OldUser).
4. In the newUserId field, enter the user's new ID (e.g. NewUser).
5. Click Test.
6. Check the message in the Test API Response field:
   • If res="ok", the change was successful. Stop here and continue to Step 4.
   • If res="err", the new user ID already exists. Continue to Step 2.

Step 2

Complete this section only if the API response from Step 1 indicates that the new user ID already exists.

1. In API Explorer open the user.getActionHistory method.
2. Set returnCount to 100.
3. Set userId to the new user ID you want to use (e.g. NewUser).
4. Click Test.
5. Check the message in the Test API Response field:
   1. If the user has any action history records, stop here and continue to Step 3.
   2. If there are no action history records for the user ID, it is safe to delete that user.
      1. Open the user with the new user's ID in the User Management view (e.g. NewUser).
      2. Click Delete (), and then confirm the deletion.
      3. Repeat Step 1 to change the user's ID.

Step 3

Complete this section only if the API response from Step 2 returns action history records for the new user ID. This will move the action history to a new user.

1. Open Nitro Studio > Tools > API Explorer.
2. Open the user.modifyUserId method.
3. In the oldUserId field, enter the new user's ID (e.g. NewUser).
4. In the newUserId field, enter a user ID that you'll delete later (e.g. DISCARD_NewUser).
5. Click Test.
6. Keep the user.modifyUserId method open.
7. In the oldUserId field, enter the user's existing ID (e.g. OldUser).
8. In the newUserId field, enter the user's new ID (e.g. NewUser).
9. In the User view, open the "to delete" user's details (e.g. DISCARD_NewUser).
10. Review the action history to determine what needs to be moved to the user's new ID (e.g. NewUser). You can manually complete missions or create an actions file for import depending on the number of items you feel are important to move.
11. (Optional) Once all action history is moved to the new user, you can delete the "to delete" user (e.g. DISCARD_NewUser). Or, you can leave this user in Nitro.
12. Continue to Step 4.

Step 4

If necessary, fix the user's registration information.

• If you are not using Bunchball Go, stop here.
• If you are using Bunchball Go with SSO, stop here. SSO will automatically register the new gamification ID in Nitro upon next login.
• If you are using Bunchball Go without SSO and:
  • you know the user's username, we can modify that username to point to the new gamification ID.
  • you do not know the user's username, we can provide a link to re-register manually to Bunchball Go with the new gamification ID. The user will have to set a new unique username.

See also

Group management

Studio users

Preferences