Bulk Update

This endpoint allows updating multiple user records in a single request by providing the necessary data through a CSV file.

Authorization

Bearer token Required

Found in the platform under community settings > API keys.
Permission: Bulk Update User

CSV file

The CSV file template can be found in the userlist page, the file must follow the given template for field names.

Include all the columns that update is required, columns that do not need update can be removed.

For numerical fields

Numerical fields have a operator which allow users to add , subtract or overwrite the value. (case sensitive, do not capitalise)

This is added in the column before the field value, with the heading: field name_op.

Example:

Note: Non-numerical fields will be overwriten.

After sending the request

After the file is uploaded and send, head to the API log in the community setting to track its progress.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST '/apis/v1/users/bulk-update' \ --header 'Authorization: Bearer <token>' \ --form 'data=@"/Users/heinwaiyanhtet/Downloads/boolean - Sheet1 (2).csv"' \ --form 'log_name=""'

{ "status": "success", "message": "Bulk update user process is queued", "data": { "message": "Bulk update user process is queued. You can check in Api Log ( community settings )" } }

Authorization

CSV file

For numerical fields

After sending the request

Request

Responses

Bulk Update

Authorization#

CSV file#

For numerical fields#

After sending the request#

Request

Responses

Authorization

CSV file

For numerical fields

After sending the request