Start a Bulk User Action
POST {{baseUrl}}/.api/api.svc/bulk_user_action/create_job?type=Update&csvData=firstname,lastname,email,password%0D{{$randomFirstName}},{{$randomLastName}},{{$randomEmail}},{{$randomWord}}-{{$randomWord}}&title=Bulk User Upload for {{$randomDepartment}}&groupDelimiter=""&spaceDelimiter=""&skipString =""&clearString ="$CLEAR"
This API endpoint creates a bulk action job or updates a previous action. An example would be adding multiple members at once.
Using the delimiters: To add or remove a user from multiple groups (Under the subsection of groupsToAdd, groupsToRemove in the CSV file), use the group delimiter (I) inside the field and/or the space delimiter (~).
For example, GroupA | GroupB | Space1~Group1
This separates the user into different groups or spaces.
Note: If you are adding or removing a user from an Administrator group or adding or removing a user from a space's Member, you MUST use the following convention:
,GroupA | GroupB | Space1\~Space Members | Space1\~Space Admins,
Request Params
| Key | Datatype | Required | Description |
| type | string | | (Required) - String
The type of bulk action being performed.
Accepted values: Update or Delete |
| csvData | string | | String
The contents of a comma separated values file containing the list of fields for bulk action. For more information on how this should be formatted, see Customer Care: Bulk Upload |
| title | string | | String
The title of the action being done, for reference when looking up the job. |
| groupDelimiter | string | | String
The group delimiter (I by default) is used to separate data into different groups from the text file. |
| spaceDelimiter | string | | String
The space delimiter (~ by default) is used to separate spaces within the groups from the text file. |
| skipString | string | | String
To skip a field from the CSV file |
| clearString | string | | String
The value used in the csv file to clear the value in a user's profile. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | The type of response data to request. By default this endpoint will respond with XML.
The options are:
- application/json
- application/xml |
RESPONSES
status: OK
{"minRequestPeriod":0,"requestSupportCode":637756142367265275,"dictionary":null,"response":{"__type":"BulkUserActionJob:http://schemas.iglooplatform.com/Igloo.Old.Common","id":"{{$randomInt}}{{$randomInt}}","href":"/.member_bulk_action/{{$randomInt}}{{$randomInt}}","navType":0,"CommunityId":"{{$randomUUID}}","CreatedAt":"/Date(1640017436727-0500)/","JobStatus":0,"NumNew":0,"NumProcessed":0,"NumSuccess":0,"Title":"{{$randomBsNoun}}","Type":0,"UserId":"{{$randomUUID}}"}}