Bulk index employees

Replaces all the currently indexed employees using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints.

SecurityBearerAuth
Request
Request Body schema: application/json; charset=UTF-8
required
uploadId
required
string

Unique id that must be used for this bulk upload instance

isFirstPage
boolean

true if this is the first page of the upload. Defaults to false

isLastPage
boolean

true if this is the last page of the upload. Defaults to false

forceRestartUpload
boolean

Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true

required
Array of objects (EmployeeInfoDefinition)

Batch of employee information

disableStaleDataDeletionCheck
boolean

True if older employee data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than 20%. This must only be set when isLastPage = true

Responses
200

OK

400

Bad Request

401

Not Authorized

409

Conflict

post/bulkindexemployees
Request samples
application/json; charset=UTF-8
{
  • "uploadId": "string",
  • "isFirstPage": true,
  • "isLastPage": true,
  • "forceRestartUpload": true,
  • "employees": [
    • {
      • "email": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "preferredName": "string",
      • "id": "string",
      • "phoneNumber": "string",
      • "location": "string",
      • "structuredLocation": {
        • "deskLocation": "string",
        • "timezone": "string",
        • "address": "string",
        • "city": "string",
        • "state": "string",
        • "region": "string",
        • "zipCode": "string",
        • "country": "string",
        • "countryCode": "string"
        },
      • "title": "string",
      • "photoUrl": "http://example.com",
      • "businessUnit": "string",
      • "department": "string",
      • "datasourceProfiles": [
        • {
          • "datasource": "github",
          • "handle": "string",
          • "url": "string",
          • "nativeAppUrl": "string",
          • "isUserGenerated": true
          }
        ],
      • "teams": [],
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24",
      • "bio": "string",
      • "pronoun": "string",
      • "alsoKnownAs": [
        • "string"
        ],
      • "profileUrl": "string",
      • "socialNetworks": [
        • {
          • "name": "string",
          • "profileName": "string",
          • "profileUrl": "string"
          }
        ],
      • "managerEmail": "string",
      • "managerId": "string",
      • "type": "FULL_TIME",
      • "relationships": [
        • {
          • "name": "string",
          • "email": "string"
          }
        ],
      • "status": "CURRENT",
      • "additionalFields": [
        • {
          • "key": "string",
          • "value": [
            • { }
            ]
          }
        ]
      }
    ],
  • "disableStaleDataDeletionCheck": true
}