Request format
In order to create a user you must send a JSON:API spec JSON object representing a user.
Required attributes
As a bare minimum, first_name, last_name, and email must be supplied.
user_type must also be supplied. Possible values are employee and recruiter.
Optional attributes
time_zone can also be supplied. This should be one of the TZ Identifiers from the List of TZ Database Timezones . E.g. America/New_York.
It is suggested to use a physical location E.g. America/New_York for this rather than a specific timezone e.g. EST, as specifying a location will ensure that Pinpoint is able to obey daylight savings correctly (when relevant).
Sending an invitation email
Depending on the use case you may want to send the user an invitation email when they are created. By default no email will be sent.
In order to send the user an invitation you must supply a send_invitation attribute with a value of true.
Examples
{
"data": {
"type": "users",
"attributes": {
"email": "[email protected]",
"first_name": "Joe",
"last_name": "Bloggs",
"user_type": "employee",
}
}
}
{
"data": {
"type": "users",
"attributes": {
"email": "[email protected]",
"first_name": "Joe",
"last_name": "Bloggs",
"time_zone": "Europe/London",
"user_type": "employee",
"send_invitation": true
}
}
}