3690866 - Sample payload for Mass Initiate Onboarding Journeys API

Symptom

Users may require a reference for constructing the payload for the Mass Initiate Onboarding Journeys API.

This KBA provides a sample payload for reference, as the example available in the SAP Business Accelerator Hub documentation may not clearly reflect the expected request structure, which can lead to confusion while forming API requests.

Environment

SAP SuccessFactors Onboarding

Cause

The sample payload provided in the SAP Business Accelerator Hub documentation may not fully align with the expected request structure.

While the API schema is correct, the example payload in the documentation may lead to discrepancies when used as a reference.

Resolution

The payload sample is not updated correctly in the document at SAP Business Accelerator Hub - the schema is correct, yet the example is incorrect. Correction is in progress from engineering side.

Kindly refer to below sample payload in this KBA until the correction has been applied:

*Notice:

For each single candidate, the userName, userId, atsApplicationId should be unique.
- To check if userName/userId already exists: Go to Admin Center > Data Inspector > Table_USERS_SYSINFO > filter with Username or User Sys ID and check if any record
If having no values for assignmentId, personId, terminatedLegacyUserId, it's ok to remove the lines.

(1) Sample payload for single candidate initiation:

(2) Sample payload for multiple candidate initiation (more records added within the array):

{
"newHireCreateJourneyRequests": [
{
"firstName": "string",
"lastName": "string",
"lastName": "string",
"email": "string",
"userName": "string",
"startDate": "2025-01-01",
"manager": "string",
"company": "string",
"eventReason": "string",
"status": "string",
"userId": "string",
"assignmentId": "string",
"personId": "string",
"journeyType": "ONBOARDING",
"journeySubType": "NewHire",
"terminatedLegacyUserId": "string",
"initiatorDetails": {
"atsApplicationId": "string"
}
},
{
"firstName": "string",
...
...
(same fields as above)
...
...
"initiatorDetails": {
"atsApplicationId": "string"
}
},
{
"firstName": "string",
...
...
(same fields as above)
...
...
"initiatorDetails": {
"atsApplicationId": "string"
}
}
]
}

(3) Similarly, below is the sample payload for PATCH API for onboarding cancellation：

{
"newHireUpdateJourneyRequests": [
{
"journeyId": "string",
"status": "CANCEL",
"cancelReason": "No Show",
"cancelEventReason": "No Show Event Reason"
}
]
}

(4) Sample Payload for Rehire with New Employment Scenario

For initiating an onboarding journey for a Rehire with New Employment (RONE) scenario using the Mass Initiate Onboarding Journeys API, please refer to the below sample payload.

Important:

The journeySubType must be maintained as REHIRE_NEW_EMPLOYMENT.
The eventReason should be a valid hire event reason (for example, HIRNEW).
Using a rehire-specific event reason may result in validation errors.
The terminatedLegacyUserId field must be provided to link the candidate’s previous employment.
Ensure that all unique identifiers such as userName, userId, and atsApplicationId are not duplicated across requests.

(5) Sample Payload for Mixed Scenario (Rehire with New Employment and New Hire)

The API supports initiating multiple onboarding journeys of different types within a single request. This includes a combination of Rehire with New Employment (RONE) and New Hire scenarios.

Important:

Ensure that each record contains the correct journeySubType:

REHIRE_NEW_EMPLOYMENT → for Rehire with New Employment
NewHire → for New Hire scenario
For RONE records, the field terminatedLegacyUserId must be provided.
The eventReason must be a valid hire event reason (for example, HIRNEW) for all records.
All unique identifiers (userName, userId, atsApplicationId) must not be duplicated across entries.

Sample payload:

{
"newHireCreateJourneyRequests": [
{
"firstName": "string",
"lastName": "string",
"email": "string",
"userName": "string",
"startDate": "2025-01-01",
"manager": "string",
"company": "string",
"eventReason": "HIRNEW",
"status": "INITIATE",
"userId": "string",
"assignmentId": "RehireOnNewEmpBulkAPI",
"personId": "string",
"journeyType": "ONBOARDING",
"journeySubType": "REHIRE_NEW_EMPLOYMENT",
"terminatedLegacyUserId": "string",
"initiatorDetails": {
"atsApplicationId": "string"
}
},
{
"firstName": "string",
"lastName": "string",
"email": "string",
"userName": "string",
"startDate": "2025-02-01",
"manager": "string",
"company": "string",
"eventReason": "HIRNEW",
"status": "INITIATE",
"userId": "string",
"journeyType": "ONBOARDING",
"journeySubType": "NewHire",
"initiatorDetails": {
"atsApplicationId": "string"
}
}
]
}

Keywords

SAP, SuccessFactors, Onboarding, Mass Initiate Onboarding Journeys, Mass Onboarding Initiation, cancellation, API, payload, new hire, rehire with new employment, example, sample, OBX-41402 , KBA , LOD-SF-OBX-ATS , ATS Integration , How To

Product

SAP SuccessFactors Onboarding 2511

3690866 - Sample payload for Mass Initiate Onboarding Journeys API - Onboarding