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
Message| Name | 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": "U3t/1NB6i0CNKFGuQRNpCw==",
"identifierGuid": "d47f7b53-7ad0-408b-8d28-51ae4113690b",
"priority": 2,
"createdUtc": "2026-04-03T06:24:56.0314369",
"receivedUtc": "2026-04-03T06:24:56.0314369",
"rsvpUtc": "2026-04-03T06:24:56.0314369",
"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": [
"7481e78c-4ef7-4bd2-b7fa-183191b13117",
"25e77572-49e0-488b-8db7-d386689799ea"
],
"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>2026-04-03T06:24:56.0314369+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>U3t/1NB6i0CNKFGuQRNpCw==</Identifier>
<IdentifierGuid>d47f7b53-7ad0-408b-8d28-51ae4113690b</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>7481e78c-4ef7-4bd2-b7fa-183191b13117</d2p1:guid>
<d2p1:guid>25e77572-49e0-488b-8db7-d386689799ea</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-04-03T06:24:56.0314369+00:00</ReceivedUtc>
<RsvpUtc>2026-04-03T06:24:56.0314369+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:
"e58a472f-1779-4045-8c58-073bb861d589"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">e58a472f-1779-4045-8c58-073bb861d589</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 3�\ar�� 5 xl/workbook.xml � (� ����0��&�C���#8q����[�H[ҭ�Ǘ�@������S�>��_�c{Gy(��qȅ�V�:�ݴS>X��O�2-־}[tQ�R^D������X4��4b����`��Ɗ����H�����l2���o�X`�Ţ��%�!g�s�J�pr3
�����i֝U'���a��~W_PK 3�\���� � [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
3�\8��' ' _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="Reb69ec9da02c400a" /></Relationships>PK 3�\����% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%m����T��j�M;lg�85�H�ϟ!�4i� [~~��T���
��hk�^e��m���R�)�;~h���+��n���\�0��#�
G�T��(u�}�[8a;�Al��Q8d )������.?:�]�`���HmySu�أ{栯�q͙h��|�0�_1�c|"^c���<KX�|Nʯ�u��io8?���@*SO��O73:�3#��uT��ݪ�n�MY�OE�S��|@��b�I�'dS9��Keb�Q��'�$�i�[�U�{����үhK�Έ\R����PK 3�\��m�� P xl/_rels/workbook.xml.rels � (� ���n� @�׀�&���K�$?��0Vl���ͷe�'��R�%R�.�Nw�=�>/���<�W�at�ì���N�v��)�o7�L"���K@iĆ��!A�E(�6u��)�Y�<�HIiC|���Lt8/���z����i� �7�� D��;�S
�X��������V0AK�j����nj!�'�^�y&�eS>)�Z^55���2FxP���K�Ny9�����bUՋZ���Fn���PK 3�\Ѓ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 3�\���� � xl/sharedStrings.xml � (� 5�An� E��fO����E���= �'1�\�8jo_���������;/��B4
i,S�� ��ځb�4ť��<��:%`Y/��8c�|(+RMe�Q*nO��q�Q�b�֞L��@�e'�ZP;��o�\)x ع��LJn���[�vڍ�Ӷ��ݩ�:w�F�7}S_�_PK- 3�\ar�� 5 xl/workbook.xmlPK- 3�\���� � � [Content_Types].xmlPK-
3�\8��' ' U _rels/.relsPK- 3�\����% � � xl/worksheets/sheet1.xmlPK- 3�\��m�� P 8 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
xl/styles.xmlPK- 3�\���� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK 3�\��?� 5 xl/workbook.xml � (� ����0��&�C���R8q���{)�4П�5���H�yۙ��v�l��3����/]��lI�(�OƂ���8�C��EL�K�o:��҂8�x�F�AZ�W�?,o�� AM+Jq�q}< ĖfO �O2[��Dd
��K��")���
7<p��s�*|�ȕ2��@3q)�^��w�cd�]PK 3�\���� � [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
3�\7=�
' ' _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="Re78e01e67bc848bd" /></Relationships>PK 3�\����% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%m����T��j�M;lg�85�H�ϟ!�4i� [~~��T���
��hk�^e��m���R�)�;~h���+��n���\�0��#�
G�T��(u�}�[8a;�Al��Q8d )������.?:�]�`���HmySu�أ{栯�q͙h��|�0�_1�c|"^c���<KX�|Nʯ�u��io8?���@*SO��O73:�3#��uT��ݪ�n�MY�OE�S��|@��b�I�'dS9��Keb�Q��'�$�i�[�U�{����үhK�Έ\R����PK 3�\�~<8� P xl/_rels/workbook.xml.rels � (� ��=n� ����^C���*$K��i.���X���6g��#�
E��:R�.��/�>�����ٽM#y��$�
����z �d�ְ�n�8��7��H�%ؔ�J��8�X�]�&�rz:+}T=RΘ�aɀk&9�g��3h|��4�K���h��
=& ?�H/aUd*��N�ץ�[V�n
��L-�����^Ȕ�0a�V�jusS�v�)�^:-���kkQqeS����ѫ��~PK 3�\Ѓ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 3�\���� � xl/sharedStrings.xml � (� 5�An� E��fO����E���= �'1�\�8jo_���������;/��B4
i,S�� ��ځb�4ť��<��:%`Y/��8c�|(+RMe�Q*nO��q�Q�b�֞L��@�e'�ZP;��o�\)x ع��LJn���[�vڍ�Ӷ��ݩ�:w�F�7}S_�_PK- 3�\��?� 5 xl/workbook.xmlPK- 3�\���� � [Content_Types].xmlPK-
3�\7=�
' ' V _rels/.relsPK- 3�\����% � � xl/worksheets/sheet1.xmlPK- 3�\�~<8� P 9 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
xl/styles.xmlPK- 3�\���� � � xl/sharedStrings.xmlPK � �