ALalianza
Bulk Operation Job

Create new job

Create a new job. This endpoint can take two content types -- application/json and multipart/form-data. Please see the request body examples for the content type you will be using.

post/v2/bulk-user-operation/job

Request

Request body

idstring

Unique identifier of the job

ownerIdstring

Owner identifier of the job

jobTypeIdstring required

Type identifier of the job

targetAccountIdstring required

Target account identifier for the job

inputCollectionIdstring required

Input collection identifier for the job

jobStatus'CREATED' | 'STARTED' | 'ABORTED' | 'COMPLETED'
executionStatus'CREATED' | 'STARTED' | 'ABORTED' | 'COMPLETED'
updatedDateTimestring date-time

Timestamp of the last update in ISO 8601 format

outputCollectionsobject
abortAfterinteger

Time after which the job should be aborted

Example request

{
  "jobTypeId": "create users | delete users | create telephone numbers | delete telephone numbers",
  "targetAccountId": "456",
  "inputCollectionId": "789"
}

Response

Job created successfully

idstring

Unique identifier of the job

ownerIdstring

Owner identifier of the job

jobTypeIdstring required

Type identifier of the job

targetAccountIdstring required

Target account identifier for the job

inputCollectionIdstring required

Input collection identifier for the job

jobStatus'CREATED' | 'STARTED' | 'ABORTED' | 'COMPLETED'
executionStatus'CREATED' | 'STARTED' | 'ABORTED' | 'COMPLETED'
updatedDateTimestring date-time

Timestamp of the last update in ISO 8601 format

outputCollectionsobject
abortAfterinteger

Time after which the job should be aborted

Example response

{
  "jobTypeId": "create users | delete users | create telephone numbers | delete telephone numbers",
  "targetAccountId": "456",
  "inputCollectionId": "789"
}

Changes

No recorded changes to this operation across all 1 revision of this API.