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

Sample payload for Mass Initiate Onboarding Journeys API.

SAP SuccessFactors Onboarding

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:

{
"newHireCreateJourneyRequests": [
{
"firstName": "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"
}
}
]
}

(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"
}
]
}

SAP Business Accelerator Hub: https://api.sap.com/api/sap-sf-newhirejourney-v1/resource/Journeys (correction in progress)

SAP, SuccessFactors, Onboarding, Mass Initiate Onboarding Journeys, Mass Onboarding Initiation, cancellation, API, payload, example, sample, OBX-41402 , KBA , LOD-SF-OBX-ATS , ATS Integration , Problem