Summary

To streamline the process of adding multiple members to your loyalty program, Annex Cloud provides a Create Bulk User API. This allows you to upload member data in batches (up to 100 members per request) through a simple API call using tools like Postman. Bulk uploading not only saves time but also ensures data consistency across all member records. This guide walks you through the step-by-step process of using the API to upload members efficiently, with optional support for extended attributes.

Steps to Bulk Upload Members via API

To upload members in bulk, follow the steps below using the User API in Postman:

Step 1: Open User API in Postman

• Launch Postman and ensure you are connected to the correct environment (with authentication headers in place).
• Navigate to the User API section within your API collection.

Step 2: Select the "Create Bulk User" Endpoint

• Within the User API, locate and select the Create Bulk User endpoint.
• This endpoint is specifically designed to handle multiple user entries in a single API request.

API Endpoint Information

Step 3: Populate the Request Body with User Data

Navigate to the "Body" tab in Postman.

• Select the raw format and choose JSON as the body type.
• Add the member data as objects in an array, separated by commas.

Step 4: Add Extended User Attributes (Optional)

If you wish to include extended attributes (like date of birth, gender, preferences, etc.), follow the structured process detailed in the documentation below: Utilizing Extended User Attributes via the API

Step 5: Send the Request

Once all member information is added:

• Click the "Send" button in Postman.
• Upon a successful response (200 OK), the members will be uploaded to the respective site.

• You can verify the upload by checking the Members Report, where all newly added members will be listed.