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": "0e5hdDeaakC56TBLA2dbHQ==", "identifierGuid": "7461eed1-9a37-406a-b9e9-304b03675b1d", "priority": 2, "createdUtc": "2025-08-02T23:26:07.4968032", "receivedUtc": "2025-08-02T23:26:07.4968032", "rsvpUtc": "2025-08-02T23:26:07.4968032", "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": [ "45a4aec6-eacd-4b22-91a1-f64d5650cb07", "820cefd8-fe62-4ea4-9570-fa01207eafef" ], "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-08-02T23:26:07.4968032+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>0e5hdDeaakC56TBLA2dbHQ==</Identifier> <IdentifierGuid>7461eed1-9a37-406a-b9e9-304b03675b1d</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>45a4aec6-eacd-4b22-91a1-f64d5650cb07</d2p1:guid> <d2p1:guid>820cefd8-fe62-4ea4-9570-fa01207eafef</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-08-02T23:26:07.4968032+00:00</ReceivedUtc> <RsvpUtc>2025-08-02T23:26:07.4968032+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:
"5801e52c-c12b-4c40-851a-a92b51c75442"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5801e52c-c12b-4c40-851a-a92b51c75442</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK C�[�VC� 5 xl/workbook.xml � (� ��;�0D�H����8"�hҦH��ul�?��㇏@J�ngv��T�C��@>f��5U)���(����;邁4��bNJ-�u�m�&vͲ�!ig��>ҍ�+���G��̸�hK��ji��8�U��^w1 �B�7U���bUĂ������չ�5唄R��dW�8Ϲ}�s���Ul��|PK C�[���� � [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 C�[B(�' ' _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="R89369db66d7b46e1" /></Relationships>PK C�[8���% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w�n��@m'�i�� �кK�&��t�瓤!q�Ė��{v��� � �}-B �-v֟k9��n/M5#]� ���&��Q)n 8�+��Z��t�)���m�����)��"t�Rl��ra����ܰP9m�l��F��^�|ZK��*#�-��+i�O�KJ^�Z���OY��D�����3س qC������Φ�I��-��킩e�_mv���a[ޗ�2v�tKyq���y�A7�,(�#{��<��Fq��^��R��O��_�M�� 1 e���k� PK C�[��+� P xl/_rels/workbook.xml.rels � (� ��=n!F���ϲ������4i_ ð��p�-E��+9R��R�q��xz����c�y�F�)�K`M�f�c�7w�Y��8�Rod7�L��%�R��Y;�TnBD_;6�I�Z��F��G��vIӜ�L�;E�1X;h|�8�/��kH����J= ?Q��5� ��H�*�_.Lk#C �jj��F̿^��L�5v����D��Ue�Jh�K���;��v�� c��ɞ��ſXPK C�[Ѓ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 C�[�1�� � xl/sharedStrings.xml � (� 5�Mn� ���fO��I� �E���9 ����W��K]~z��{��(����s� �I�@Ju�t����!G�"�q��<�A\�gn�O�'XZ�ޔ�`�|�RO��^b��o;ƙ�VVe�>�3�H��ֵ ����s��[p�6�l��؛Ҡ��L���ޜI/n�W-x��W�U�PK- C�[�VC� 5 xl/workbook.xmlPK- C�[���� � � [Content_Types].xmlPK- C�[B(�' ' U _rels/.relsPK- C�[8���% � � xl/worksheets/sheet1.xmlPK- C�[��+� P 8 xl/_rels/workbook.xml.relsPK- C�[Ѓc'2 E ~ xl/styles.xmlPK- C�[�1�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK C�[`�r4� 5 xl/workbook.xml � (� ����0��&�C��P &8q���{)[�H����[J ��mgv��if�_��/�ѓ �o���Մ.A�p�L� �5�I�'�B(��o &Z�0��� R��W�?��<�1H�����2�;j�fs�2[��Dd ��T�a�EV�0 -�Yde�6�����* �+��� �cu�C m��w�PK C�[���� � [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 C�[�J�' ' _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="R2b738904a40044a8" /></Relationships>PK C�[8���% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w�n��@m'�i�� �кK�&��t�瓤!q�Ė��{v��� � �}-B �-v֟k9��n/M5#]� ���&��Q)n 8�+��Z��t�)���m�����)��"t�Rl��ra����ܰP9m�l��F��^�|ZK��*#�-��+i�O�KJ^�Z���OY��D�����3س qC������Φ�I��-��킩e�_mv���a[ޗ�2v�tKyq���y�A7�,(�#{��<��Fq��^��R��O��_�M�� 1 e���k� PK C�[���� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8?�5�M��p&�$jbG�[��Xp$��U$p%l����I3�����<�3Y7�@���H��F�7p�ꡆ�f��I�0�qq,�h�����ĹÁf���e�,}Hm��G��Ӵ�6f�-�.��h��� �f��05��"� mO�����א%� l�5�9�V�*���[ ��M���D���;�d���+Q�X�����R��m�t��#5���� ��˕z����|PK C�[Ѓ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 C�[�1�� � xl/sharedStrings.xml � (� 5�Mn� ���fO��I� �E���9 ����W��K]~z��{��(����s� �I�@Ju�t����!G�"�q��<�A\�gn�O�'XZ�ޔ�`�|�RO��^b��o;ƙ�VVe�>�3�H��ֵ ����s��[p�6�l��؛Ҡ��L���ޜI/n�W-x��W�U�PK- C�[`�r4� 5 xl/workbook.xmlPK- C�[���� � [Content_Types].xmlPK- C�[�J�' ' V _rels/.relsPK- C�[8���% � � xl/worksheets/sheet1.xmlPK- C�[���� P 9 xl/_rels/workbook.xml.relsPK- C�[Ѓc'2 E � xl/styles.xmlPK- C�[�1�� � � xl/sharedStrings.xmlPK � �