Create a new user (POST)
This API allows you to create one user at a time in your Alumni platform.
Call
In this call, you will be able to send the fields and values you want your new user to have, these values need to be organized the same way they are in the Return user schema API response. Also, it is possible to use the “disabledRequiredFields” flag, which will disable the system validation for required fields if true, making it possible to perform calls without including all the required fields, the default value for this flag is FALSE. Finally, it is also possible to use the “sendMail” flag, which will trigger the “Welcome” system email for the created user, the default value for this flag is FALSE. To create a user there are only 3 fields that are required, which are email, first name, and last name. This is because it is the minimum information needed to create a new user in the IDP system.
Notes
- By default, the API will check if the required fields are populated in the payload.
- To send the "Welcome" email the system email "Welcome to AccessPassport" needs to be enabled in the platform. Also enable the systems email Bounce Migrated 1 and 2 that are sent 24 and 48 hours if the user have not started signing up.
Example
The following example shows a schema that will create the user John Doe with their email address and some extra fields:
{
"firstName": "John",
"lastName": "Doe",
"communicationEmailAddress": "[email protected]",
"field1": "value 1",
"field2": "value 2",
"...",
"fieldN": "value N"
}Response
This API will return the new user’s unique identifier (userResourceGuid) if it is successful or a message with the error if there is any error.
Example
{
"userResourceGuid": "057436bb-2d7e-4dc1-a9e0-b2bf275064f6"
}*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.
Updated 24 days ago