DATE:
AUTHOR:
The Toast - API team
Menus API

posName, posButtonColorLight, and posButtonColorDark added to Premodifier object in menus API

DATE:
AUTHOR: The Toast - API team

The Premodifier object of the menus API has been updated with the following values:

  • posName: Specifies the button label name displayed for the premodifier in the Toast POS app.

  • posButtonColorDark: Defines the button color for the premodifier in the Toast POS app when it is in dark mode. The color is specified in hexadecimal RGB notation.

  • posButtonColorLight: Defines the button color for the premodifier in the Toast POS app when it is in light mode. The color is specified in hexadecimal RGB notation.

When an employee configures the POS button color for a premodifier, they select a color pairing that consists of two colors, one for light mode and one for dark mode. posButtonColorLight contains the hexadecimal (hex) code for the light mode color. posButtonColorDark contains the hex code for the dark mode color.

The default color pairing is WHITE. In the WHITE color pairing, posButtonColorLight is #f7f7f7 and posButtonColorDark is #1a1c23.

For a table that shows the color pairing names and the color hex codes for light and dark mode associated with each pairing, see POS button color hex codes for light and dark modes.

Like all changes to the menus API, these new values become available in the menu JSON after a restaurant has made a menus-related change and published the new menu, which regenerates the restaurant's menu data. For more information, see Menus API returns published data only.

This change applies to both V2 and V3 of the menus API.

Note

For information on the differences between V2 and V3 of the menus API, see Comparing menus API V2 and V3.

Powered by LaunchNotes