PUT api/pos/message/{id}

Place PopupMessage object at the guid location

Request Information

URI Parameters

Name	Description	Type	Additional information
id	PopupMessage guid to use when saving PopupMessage	globally unique identifier	Required

Body Parameters

Price Group object to save

PopupMessage

Name	Description	Type	Additional information
G_UID	Dialog message identifier	Collection of byte	None.
Guid	Text version of dialog message identifier	globally unique identifier	None.
Name	Dialog message name	string	String length: inclusive between 0 and 40
Title	The text that is displayed at the top of the dialog prompt	string	String length: inclusive between 0 and 60
AssistanceRequired	if true an operator has to scan to dismiss the prompt	boolean	None.
SkipLights	if true self-serve lights will not change colour when the prompt is displayed	boolean	None.
Html	The html that will be rendered on the form, if null or empty no html box will be displayed)	string	None.
HtmlWidth	Width of html box, between 200-1000px, default is 700px	integer	None.
HtmlHeight	height of html box, between 200-1000px, default is 400px	integer	None.
SoundName	The name of the local sound file that will be played when the form is open	string	String length: inclusive between 0 and 191
CloseButtonText	Text displayed on the close button, defaults to 'Close'	string	String length: inclusive between 0 and 20
Highlight	If true the dialog will be highlighted (background dimmed)	boolean	None.
DisableScanner	if true the scanner will be disabled while the form is displayed	boolean	None.
Timeout	The length of time in seconds the form will be displayed for (if 0 the form will not timeout)	integer	None.
Deleted	Soft deletion flag	boolean	None.
ProductCount	product count	integer	None.
CampaignCount	campaign count	integer	None.
SellingRuleCount	selling rule count	integer	None.
Created	Creation date	date	None.
CreatedOn	text version of creation date, dd/mm/yyyy	string	None.
Updated	Last updated date	date	None.

Request Formats

application/json, text/json

Sample:

{
  "g_UID": "UpI3Av8sJU+S7dlCcAcSvg==",
  "guid": "02379252-2cff-4f25-92ed-d942700712be",
  "name": "sample string 2",
  "title": "sample string 3",
  "assistanceRequired": true,
  "skipLights": true,
  "html": "sample string 4",
  "htmlWidth": 1,
  "htmlHeight": 1,
  "soundName": "sample string 5",
  "closeButtonText": "sample string 6",
  "highlight": true,
  "disableScanner": true,
  "timeout": 1,
  "deleted": true,
  "productCount": 1,
  "campaignCount": 1,
  "sellingRuleCount": 1,
  "created": "2025-06-14T06:10:07.3044502",
  "createdOn": "sample string 7",
  "updated": "2025-06-14T06:10:07.3044502"
}

application/xml, text/xml

Sample:

<PopupMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Pos.PopupMessage">
  <AssistanceRequired>true</AssistanceRequired>
  <CampaignCount>1</CampaignCount>
  <CloseButtonText>sample string 6</CloseButtonText>
  <Created>2025-06-14T06:10:07.3044502+00:00</Created>
  <CreatedOn>sample string 7</CreatedOn>
  <Deleted>true</Deleted>
  <DisableScanner>true</DisableScanner>
  <G_UID>UpI3Av8sJU+S7dlCcAcSvg==</G_UID>
  <Guid>02379252-2cff-4f25-92ed-d942700712be</Guid>
  <Highlight>true</Highlight>
  <Html>sample string 4</Html>
  <HtmlHeight>1</HtmlHeight>
  <HtmlWidth>1</HtmlWidth>
  <Name>sample string 2</Name>
  <ProductCount>1</ProductCount>
  <SellingRuleCount>1</SellingRuleCount>
  <SkipLights>true</SkipLights>
  <SoundName>sample string 5</SoundName>
  <Timeout>1</Timeout>
  <Title>sample string 3</Title>
  <Updated>2025-06-14T06:10:07.3044502+00:00</Updated>
</PopupMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.