PUT api/message/{id}
Update a message
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Message identifier |
globally unique identifier |
Required |
Body Parameters
Message to save
MessageName | Description | Type | Additional information |
---|---|---|---|
Identifier | Collection of byte |
None. |
|
IdentifierGuid | globally unique identifier |
None. |
|
Priority | integer |
None. |
|
CreatedUtc | date |
None. |
|
ReceivedUtc |
Dismissed at |
date |
None. |
RsvpUtc |
Snoozed until |
date |
None. |
Sender | string |
String length: inclusive between 0 and 255 |
|
Action | MessageAction |
None. |
|
DocumentObject | Object |
None. |
|
Document | string |
None. |
|
DocumentType | string |
String length: inclusive between 0 and 255 |
|
External | boolean |
Relation. This field may not always be loaded or used for updates. |
|
Stores | Collection of integer |
Relation. This field may not always be loaded or used for updates. |
|
StoreName | string |
Relation. This field may not always be loaded or used for updates. |
|
Operators | Collection of globally unique identifier |
Relation. This field may not always be loaded or used for updates. |
|
Users | Collection of string |
Relation. This field may not always be loaded or used for updates. |
|
Machines | Collection of string |
Relation. This field may not always be loaded or used for updates. |
Request Formats
application/json, text/json
Sample:
{ "identifier": "Gye2kTVLn0epR3Pgb65PKw==", "identifierGuid": "91b6271b-4b35-479f-a947-73e06fae4f2b", "priority": 2, "createdUtc": "2025-10-04T23:57:23.1786922", "receivedUtc": "2025-10-04T23:57:23.1786922", "rsvpUtc": "2025-10-04T23:57:23.1786922", "sender": "sample string 4", "action": 1, "documentObject": { "$id": "2" }, "document": "sample string 6", "documentType": "sample string 7", "external": true, "stores": [ 1, 2 ], "storeName": "sample string 9", "operators": [ "255b861c-ade9-4e3d-a9b9-4ab4ba6fe4e6", "cfeca71f-d177-4405-b180-d7c5eeed14b7" ], "users": [ "sample string 1", "sample string 2" ], "machines": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<Message xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager"> <Action>1</Action> <CreatedUtc>2025-10-04T23:57:23.1786922+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>Gye2kTVLn0epR3Pgb65PKw==</Identifier> <IdentifierGuid>91b6271b-4b35-479f-a947-73e06fae4f2b</IdentifierGuid> <Machines xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Machines> <Operators xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>255b861c-ade9-4e3d-a9b9-4ab4ba6fe4e6</d2p1:guid> <d2p1:guid>cfeca71f-d177-4405-b180-d7c5eeed14b7</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-10-04T23:57:23.1786922+00:00</ReceivedUtc> <RsvpUtc>2025-10-04T23:57:23.1786922+00:00</RsvpUtc> <Sender>sample string 4</Sender> <StoreName>sample string 9</StoreName> <Stores xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Stores> <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Users> </Message>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Saved message identifier
globally unique identifierResponse Formats
application/json, text/json
Sample:
"86bba3d9-70de-44d0-a3bf-63a9ac56e860"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">86bba3d9-70de-44d0-a3bf-63a9ac56e860</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK +�D[K(�� 5 xl/workbook.xml � (� ����0��&�C��� R8q�����4П�5���H�yۙ��v���Pk=����mA{�MΘkz��ڠ �N[ >H�b��D��n��g��1eG�B+���B���Eh]��帠$E���>7{ �\��X��&aK���x�mQZ�J�soz���"�ڴ��5��dMF7��l�]~PK +�D[���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK +�D[���' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R579432ba3b22482d" /></Relationships>PK +�D[��O<% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%m�,��T��j�M;lg�85�Ȑ��? �4i� [~~��Tǻ��4ښo7g`[촽�|��CɏM� ݜ�,��;P͕��A�*0�mpj=��>�t����3����.� A0H��ң�+���H �d�+�����t`��A_�Ӗ3�T ��aq�b��D��䥫y������_�u��i�o�<��*6�O=-.���7Ό��wѝW5��M�T��]�o˼ଝ�G�W�b�I�g�eS.�R9��(��� �¼s�Ub�������_�-]=PR����PK +�D[y�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8���i7l�-���L>jbG��г��H\�H�J,�t5��ӓf>�?�۷ybgt~������hێ���D݃��f��IQ��øxV��a ZV�{=�|b4��Y7+ �����Q�ȳ4-��p�d�˂�!ڮ5>[}���`�j����\�T�O��kI�۵5�j�V�"o�c^� ����˄���;�d�(�����i�YqW�A9l_ȅK�Nq9Rk�&��S��e��j��/6_PK +�D[Ѓc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK +�D[Hή � xl/sharedStrings.xml � (� 5�An� E��fO�uB� �E���=��Lb$3�\5�/Yt��������C����,(�����>��%9�R�x���/RU��0�#�L�PV��ʖ�6��F֍0�LT�b^�u&cbPSٹ6-����N��)�z7��ų~������n�i������Yoj���7�U�PK- +�D[K(�� 5 xl/workbook.xmlPK- +�D[���� � [Content_Types].xmlPK- +�D[���' ' V _rels/.relsPK- +�D[��O<% � � xl/worksheets/sheet1.xmlPK- +�D[y�� P 9 xl/_rels/workbook.xml.relsPK- +�D[Ѓc'2 E xl/styles.xmlPK- +�D[Hή � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK +�D[���?� 5 xl/workbook.xml � (� ����0��&�C��H��x��-[�H����[J ��mgv��ig�_����Ʉ�wX��B��i8Y&����$��X!���IY5�0Ѩ� R��W�?��<�1H�����2�?j�fs�2[��Dd ��T�a�EV�P h�e�6v���oT�U��W�kV/���a-�~�_PK +�D[���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK +�D[' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R1162e845740f427f" /></Relationships>PK +�D[��O<% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%m�,��T��j�M;lg�85�Ȑ��? �4i� [~~��Tǻ��4ښo7g`[촽�|��CɏM� ݜ�,��;P͕��A�*0�mpj=��>�t����3����.� A0H��ң�+���H �d�+�����t`��A_�Ӗ3�T ��aq�b��D��䥫y������_�u��i�o�<��*6�O=-.���7Ό��wѝW5��M�T��]�o˼ଝ�G�W�b�I�g�eS.�R9��(��� �¼s�Ub�������_�-]=PR����PK +�D[HA}�� P xl/_rels/workbook.xml.rels � (� ��An� E��f_cl��U�l��6��x0Vl����ٺ�z��Tj��n�B���f�|�Xo�Ɓ�ɇ��D�#���mW�)�l7�= *���S`� 5��'�U��D6u���UG��s����Lv�L��ӺGzvx��?����c0D�A��b ?Q��Cd� l�ְo�j�b��(��� ���e����]�e�R !�j���,�+c���%����<��-��Q�M��$�j��_l� PK +�D[Ѓc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK +�D[Hή � xl/sharedStrings.xml � (� 5�An� E��fO�uB� �E���=��Lb$3�\5�/Yt��������C����,(�����>��%9�R�x���/RU��0�#�L�PV��ʖ�6��F֍0�LT�b^�u&cbPSٹ6-����N��)�z7��ų~������n�i������Yoj���7�U�PK- +�D[���?� 5 xl/workbook.xmlPK- +�D[���� � � [Content_Types].xmlPK- +�D[' ' U _rels/.relsPK- +�D[��O<% � � xl/worksheets/sheet1.xmlPK- +�D[HA}�� P 8 xl/_rels/workbook.xml.relsPK- +�D[Ѓc'2 E xl/styles.xmlPK- +�D[Hή � � xl/sharedStrings.xmlPK � �