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": "bnxGAZKKqESbaQpnOUSFcg==",
"identifierGuid": "01467c6e-8a92-44a8-9b69-0a6739448572",
"priority": 2,
"createdUtc": "2026-06-03T18:36:28.2778687",
"receivedUtc": "2026-06-03T18:36:28.2778687",
"rsvpUtc": "2026-06-03T18:36:28.2778687",
"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": [
"083a2d4a-4e8a-4838-94e6-0c21c8afcffe",
"62e7a562-e2a0-4a41-a98a-a68a4fb2c3b6"
],
"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-06-03T18:36:28.2778687+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>bnxGAZKKqESbaQpnOUSFcg==</Identifier>
<IdentifierGuid>01467c6e-8a92-44a8-9b69-0a6739448572</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>083a2d4a-4e8a-4838-94e6-0c21c8afcffe</d2p1:guid>
<d2p1:guid>62e7a562-e2a0-4a41-a98a-a68a4fb2c3b6</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-06-03T18:36:28.2778687+00:00</ReceivedUtc>
<RsvpUtc>2026-06-03T18:36:28.2778687+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:
"3d8675c7-daf3-48e0-92f8-56536dc82c03"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3d8675c7-daf3-48e0-92f8-56536dc82c03</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK ���\��I� 5 xl/workbook.xml � (� ����0��&�C���48q���{)[�@����%�x�3;�픣�}km�>z0���1����%hց�v�z��$��X!���ɑҜxXT��\��VpX$@�Â�L\�w�s���1$9k��Dd ��T�`�ER�0
nXd%��U8��j���9?g����$���PK ���\���� � [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
���\����' ' _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="R0dbb149f37464901" /></Relationships>PK ���\T$��$ � xl/worksheets/sheet1.xml � (� �Q�n� ��}%]�UI�IU�ݦ�3K��p�I��m����-?��l���lO]ͷ��3p-v�]k>��A�SS-�o��pGG_s�x�Z
V�Gp�֣�*��_��i��d��X��0��H�����.=�.[��Je�q��:ٓ{桯�Ӗ3�T�n`�_1Kc|"�R��ռ�X�|�ʯ�uЫio�<���7��=-�ofM�gV��.���R����<l�䬝(��X˫K��dͳ
��<.��rdOQ����(Nq)*1��x"���گ��_����s�PK ���\�g�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�iS'��vÆm���8��ؖ�=�����ĂMW��==i���c�{�F�B>�4�ge��t
��~�`���iĘ&B?��Ҋ
�1�5�A�4aȬ#�:�� cJ}��v�BH���e�����V�AѣU�L��_�?��(;��(6�S
��,Q�=�
���+!�*����e������dd��T2GMeA���L�����ӥ�N��L
�����Q�X-�U�����PK ���\Ѓ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� � xl/sharedStrings.xml � (� 5�An� E��fO�v���E�� = �q�d׃���!�.���z�^�*~p�Th����JL���~�WOѯ�p�?dWg��hS� �Z��R̞OeCj�\��k���x��G^k^U����O"��jӂ8(}���M�����f<�,��{�nPˏn6r�~��tA�VUgի��+�PK- ���\��I� 5 xl/workbook.xmlPK- ���\���� � [Content_Types].xmlPK-
���\����' ' V _rels/.relsPK- ���\T$��$ � � xl/worksheets/sheet1.xmlPK- ���\�g�� P 8 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
~ xl/styles.xmlPK- ���\*D� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK ���\��9ʶ 5 xl/workbook.xml � (� ����0��&�C��@�D��x��}��4Пtk��H�yۙ��v����i��>z4T���!�Bj{�@'���;i��0K�VJ�bc۷FD�$��8BP�P�����G�Gz\Q�����X�4{(�(����.&kH����/�b4V�� �E��U<��j�mrͥ̒��J�;{��b�]PK ���\���� � [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
���\R�_�' ' _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="Rb289c00953ad4874" /></Relationships>PK ���\T$��$ � xl/worksheets/sheet1.xml � (� �Q�n� ��}%]�UI�IU�ݦ�3K��p�I��m����-?��l���lO]ͷ��3p-v�]k>��A�SS-�o��pGG_s�x�Z
V�Gp�֣�*��_��i��d��X��0��H�����.=�.[��Je�q��:ٓ{桯�Ӗ3�T�n`�_1Kc|"�R��ռ�X�|�ʯ�uЫio�<���7��=-�ofM�gV��.���R����<l�䬝(��X˫K��dͳ
��<.��rdOQ����(Nq)*1��x"���گ��_����s�PK ���\ޛ�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8 NZ��ݰa[z�'Q۲]�gc���V��+u�������4�����|�yCFk:��i�h��Q?,a�^mq1M�at��:btO�9�,Ba�����"���� y=Һ,[�s\3����?D��(����&� �w�a@�@v��;�+zU��@^T[Y�V�T�Ь���M-�ӄ����g2��Y0��-*�l�+3��5�t��)/gjL5��9J�e{V�W��PK ���\Ѓ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� � xl/sharedStrings.xml � (� 5�An� E��fO�v���E�� = �q�d׃���!�.���z�^�*~p�Th����JL���~�WOѯ�p�?dWg��hS� �Z��R̞OeCj�\��k���x��G^k^U����O"��jӂ8(}���M�����f<�,��{�nPˏn6r�~��tA�VUgի��+�PK- ���\��9ʶ 5 xl/workbook.xmlPK- ���\���� � � [Content_Types].xmlPK-
���\R�_�' ' U _rels/.relsPK- ���\T$��$ � � xl/worksheets/sheet1.xmlPK- ���\ޛ�� P 7 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
} xl/styles.xmlPK- ���\*D� � � xl/sharedStrings.xmlPK � �