SAP Knowledge Base Article - Public

2244514 - Welcome Message doesn't appear when an employee is created using SFAPI User entity


  • You are creating an employee record in Successfactors using SFAPI User entity.
  • Desired Behavior: New employee should receive the welcome message. 
  • Current Behavior : New employees do not get the welcome message once their information is added in Successfactors via SFAPI User entity using upsert/insert API operation.


SAP SuccessFactors - Integrations


sendWelcomeMessage parameter is not specified in the Upsert request.


sendWelcomeMessage parameter is set to "False" in the Upsert request.


Please add the parameter called "sendWelcomeMessage" at the botom of the Upsert request xml.

The following example shows how to specify the sendWelcomeMessage option when UPSERTING using User entity.

<!--1 or more repetitions:-->
<!--You may enter ANY elements at this point-->
<division>ACE Software</division>
<!--1 or more repetitions:-->

This will trigger a welcome email to the newly created employee.

See Also

sendWelcomeMessage is only for user import via API. Please include this parameter in sfapi insert/upsert only and not in the login payload.

Given this parameter provided and user is newly created, you can expect the user to get a welcome email.


welcome message doesn't work api upsert New employee upsert , KBA , LOD-SF-INT , Integrations , Problem


SAP SuccessFactors HCM Suite 1705