Updates a Person based on the unique key of Email
Base URI
Staging - https://staging-api-service.peopletray.com
Production - https://api.peopletray.com
Production (Aus Instance) - https://au1-peopletray-public-api-service.azurewebsites.net
Authentication
All requests to the PeopleTray API must be authenticated. See the Authentication page for more details
_Note: The API ignores any fields with empty values. Updates only fields that have values. More like a Patch method_
Endpoint: {baseUri}/api/v2/person/
Method: PUT
Authentication: Authentication Token should be passed as X-ZUMO-AUTH HTTP header
Response: HTTP Status Code along with success or error/validation messages if any.
Payload (body):
{
"email": "string",
"firstName": "string",
"lastName": "string",
"preferredName": "string",
"salutation": "string",
"gender": "string",
"workgroupName": "string",
"jobTitle": "string",
"dateOfBirth": "string",
"employeeId": "string",
"employerName": "string",
"mobile": "string",
"frequentFlyerNumber1": "string",
"frequentFlyerNumber2": "string",
"weight": "string",
"homePortName": "string",
"sitePortName": "string",
"costCodeName": "string",
"isCompliant": boolean
}
| Field | Type | Description |
|---|---|---|
| email* | string | Email address of the Person. This values is also used as the Username |
| firstName | string | First Name of the Person |
| lastName | string | Last Name of the Person |
| preferredName | string | Preferred Name of the Person |
| salutation | string | Salutation/Title of the Person |
| gender | string | Gender of the Person. Valid values are Male, Female and Other |
| workgroupName | string | Name of the Workgroup. If not supplied or the supplied name does not exist, the Person is assigned to the default Workgroup called "Unassigned" |
| jobTitle | string | Job Title of the Person. If not supplied or the supplied name does not exist, the Person is assigned the default Job Title called "Unassigned" |
| dateOfBirth | string | Date of Birth of the Person. Supported date format is "dd-MMM-YYYY" (01-Jan-2021) |
| employeeId | string | Employee ID of the Person. |
| employerName | string | Name of the Employer. The API creates a new Employer if not existing |
| mobile | string | Mobile number of the Person. Mobile number must match international format ( + Country Code and Mobile Number. e.g +61415xxxxxx) |
| frequentFlyerNumber1 | string | Frequent Flyer Number of the Person |
| frequentFlyerNumber2 | string | Frequent Flyer Number of the Person |
| weight | string | Weight of the Person |
| homePortName | string | Name of the Home Port. The API creates a new Port if not existing |
| sitePortName | string | Name of the Site Port. The API creates a new Port if not existing |
| costCodeName | string | Name of the Cost Code the Person is associated to. The API creates a new Cost Code if not existing |
| isCompliant | boolean | Compliance Status of the Person |
*Required Field