New chosenName value in labor API Employee object

The labor API Employee object now includes a chosenName value. The chosenName value is an optional, preferred name that employees set for themselves. The chosen name is used instead of the employee's first name in some Toast platform functionality. For example, the employee's chosen name is shown in:

• Kitchen display system (KDS) tickets

• Printed kitchen tickets

• The Toast POS app order activity screen

• Payment receipts

Employees set the chosen name in the Personal Info section of the Employees configuration page of Toast Web.

You can set the chosen name when you create an employee using a POST request and you can update an employee's chosen name using a PATCH request.

The following example shows an Employee object with the new chosenName value.

{
  "guid": "4d7651d2-0ea8-4496-97fd-558cfd3514f1",
  "entityType": "RestaurantUser",
  "externalId": "MYORG:20220804232724",
  "v2EmployeeGuid": "a59b2b0b-f9f2-44ed-be49-6d1dac49a419",
  "lastName": "Gauthier",
  "wageOverrides": [],
  "firstName": "Josephine",
  "chosenName": "Jo", //The new chosenName value includes an optional, preferred name for the employee. It is used instead of the firstName value in some Toast platform functionality.//
  "createdDate": "2022-08-05T03:27:25.799+0000",
  "deleted": false,
  "deletedDate": null,
  "jobReferences": [],
  "modifiedDate": "2022-08-05T03:30:27.609+0000",
  "disabled": false,
  "externalEmployeeId": "",
  "email": "jgauthier@example.com"
}