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": "ksv4ZsJSlkmrGcuH+an2Vg==", "identifierGuid": "66f8cb92-52c2-4996-ab19-cb87f9a9f656", "priority": 2, "createdUtc": "2025-06-14T06:04:41.4324769", "receivedUtc": "2025-06-14T06:04:41.4324769", "rsvpUtc": "2025-06-14T06:04:41.4324769", "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": [ "dfad25c8-69c4-426e-a68a-61291185cbd9", "3d3d88a0-4627-45f1-8f2e-72978e2f9828" ], "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-06-14T06:04:41.4324769+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>ksv4ZsJSlkmrGcuH+an2Vg==</Identifier> <IdentifierGuid>66f8cb92-52c2-4996-ab19-cb87f9a9f656</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>dfad25c8-69c4-426e-a68a-61291185cbd9</d2p1:guid> <d2p1:guid>3d3d88a0-4627-45f1-8f2e-72978e2f9828</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-06-14T06:04:41.4324769+00:00</ReceivedUtc> <RsvpUtc>2025-06-14T06:04:41.4324769+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:
"8972671c-f0bb-4a23-a43c-9df97757dd20"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8972671c-f0bb-4a23-a43c-9df97757dd20</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �0�Z�S�k� 5 xl/workbook.xml � (� ����0��&�C�����p��Ճ��[i�?ik��-%�x�3;������a�>z4��5�ct!��A�p�L�I뵈I��R�Z۽5�H�'�aQYz�^h���� ���z\PZ(���!>7�+�B��X��&"K���x�mY!#4ԸQ`����G�|��p+/%+�<SVco� �����PK �0�Z���� � [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 �0�Z�.<�' ' _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="R606434ae6737469d" /></Relationships>PK �0�Z`�"% � xl/worksheets/sheet1.xml � (� �Q�n� ��� i�n��T��j�M;lg�85�H��m����-?��l�����k�5+mK������=¡�fr��p���¸�ܷ ��+��ZO��Sw�����#��A�Z�w8���ң���?\~t(�l����BSu:�'��a_�S�7UF�k�����1>�.)y�j���OY�ձ{9 ��g�g��sOK��73:� ����κ���êb�.ʝ�n�5�v���R^\�&ke�M�hf.�#{��<>;��>�{mDů�7������%t'��.+��\�PK �0�Z�b{� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�1NҢ�ݰa[z��Q;�]�gc���V� �X��j4��'�|�lvo�H^0���ʂA��\��)��춛=�2�h�9���b6���Ҩ,N2~F�;ƇI�����Re��3VӰd�5��3���>zu�Х?��Շc�� �A�S?�H/�,2ȓna_�+^1�0.���7S��<b����2�\!Y'u�E�27��2�~N!_z�,/�}�)n:m$U�\���_l� PK �0�ZЃ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 �0�Z��vE� � xl/sharedStrings.xml � (� 5�Mn� ������Ca���� 0����x�U{��E���{�����Y|�J�� �;#`�)�s�_��"q��0�_ )n��hS�AN��Uk��@�� �d�k �p}jZV�&