POST api/messages
Create or update a message
Request Information
URI Parameters
None.
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": "U3qVlo/+/UCxfPuLLf1ggA==",
"identifierGuid": "96957a53-fe8f-40fd-b17c-fb8b2dfd6080",
"priority": 2,
"createdUtc": "2026-06-03T18:30:32.5103639",
"receivedUtc": "2026-06-03T18:30:32.5103639",
"rsvpUtc": "2026-06-03T18:30:32.5103639",
"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": [
"dcd89412-ae20-4782-bb1d-0c7ee6e4339b",
"96c38849-145c-4c7e-80ea-3f659258944e"
],
"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:30:32.5103639+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>U3qVlo/+/UCxfPuLLf1ggA==</Identifier>
<IdentifierGuid>96957a53-fe8f-40fd-b17c-fb8b2dfd6080</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>dcd89412-ae20-4782-bb1d-0c7ee6e4339b</d2p1:guid>
<d2p1:guid>96c38849-145c-4c7e-80ea-3f659258944e</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-06-03T18:30:32.5103639+00:00</ReceivedUtc>
<RsvpUtc>2026-06-03T18:30:32.5103639+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:
"9c464b8a-8875-457d-b5f6-950ad3452816"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9c464b8a-8875-457d-b5f6-950ad3452816</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK Г�\�� 5 xl/workbook.xml � (� ����0D�&�C�p�PR8q������4Ж�5��B $��ξ1������r[���1pMG
�Ɍ��]k�B?K�Ӷ���4oE�CE)X�K�]'G�W�?,7Z§눼V�B�yy<0&�fI�r6����`
�oJ�~Ө��z�,8�g�c�l.��GɅ����5�S����a���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="R32d1ccb7a1ff4e91" /></Relationships>PK Г�\�z�% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w�nccLm'�i�� �кK�&��t�瓤!q�Ė��{v�����
�}%��B
�
�֟+9��n'u9!]� ��TI°W�N���!9bJg�]g8b3:�A��b�z�;�������n���TN[/벵�=�]%��R����w��E���Eƪ?�SV~%�B��>����lB��&�4�s���ioR8}��d�`*��-���b��ܬv�����\�]��&ku�uI8 ��Ȟ�4g�Q��(�5������~�tB@Y����/PK Г�\��bZ� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�I����vÆm�{�DMl�v���G�
XE�Tb�������4����ݿ�yAFkZ�3��j4}�ְ�m8��&�0�@Ҋ -1�
�A8��Y�&u����)�=uB�D��`lE���Lr�8��j=J|��<������0 F G�{�-����<KT O��CΊ5�uǚN�v@���B�L~����E�/j�J�uyW�AxT�ѧK/��党�u�hUh�+���Fo�b�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 Г�\@��� � xl/sharedStrings.xml � (� 5�An� E��fOpR��E���= 1���g\��/]t�������]���J#(���L�>�ߴ�)ť���<��6%aY���4c�|�+RKu+QnO��1�(e1��L��@Mu'iZP;��_�� r�.S?�w�sg�{{N�n���.��ޞ�q�F�7}�^�_PK- Г�\�� 5 xl/workbook.xmlPK- Г�\���� � � [Content_Types].xmlPK-
Г�\�=��' ' U _rels/.relsPK- Г�\�z�% � � xl/worksheets/sheet1.xmlPK- Г�\��bZ� P 8 xl/_rels/workbook.xml.relsPK- Г�\Ѓc'2 E
xl/styles.xmlPK- �\@��� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK Г�\PKu�� 5 xl/workbook.xml � (� ����0��&�C�`�R8q���{�E�O�||K $���~;l�vl��GNʕ���{SR�%w'mP�]���>H����E������Y�\�ʼn{���q���a9c�?݀�崢$
���4{�]����.&�k���X��Q�%V�pρD��� bK�;�I�Y��9������a�n��/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
Г�\��.M' ' _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="Ra1bbd25688fb4ae3" /></Relationships>PK Г�\�z�% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w�nccLm'�i�� �кK�&��t�瓤!q�Ė��{v�����
�}%��B
�
�֟+9��n'u9!]� ��TI°W�N���!9bJg�]g8b3:�A��b�z�;�������n���TN[/벵�=�]%��R����w��E���Eƪ?�SV~%�B��>����lB��&�4�s���ioR8}��d�`*��-���b��ܬv�����\�]��&ku�uI8 ��Ȟ�4g�Q��(�5������~�tB@Y����/PK Г�\��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8q�O��ݰa[z�'Q۲]�gc���V� �X��j4��'�|�lvo�D^Їњ�,�FZ5���s�-춛=N"��0�.��bBC�nMi��"d֡Im�,bJ}O��'�#ey^S�d�-�.�C�Z��<�h�`�j�)��A�c?�@���ȓ�`�E�[�2,+^���Z�� ï�w��E���R6+�j}W�AxT�ѧK/����
����WMqU�7��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 Г�\@��� � xl/sharedStrings.xml � (� 5�An� E��fOpR��E���= 1���g\��/]t�������]���J#(���L�>�ߴ�)ť���<��6%aY���4c�|�+RKu+QnO��1�(e1��L��@Mu'iZP;��_�� r�.S?�w�sg�{{N�n���.��ޞ�q�F�7}�^�_PK- Г�\PKu�� 5 xl/workbook.xmlPK- Г�\���� � � [Content_Types].xmlPK-
Г�\��.M' ' U _rels/.relsPK- Г�\�z�% � � xl/worksheets/sheet1.xmlPK- Г�\��� P 8 xl/_rels/workbook.xml.relsPK- Г�\Ѓc'2 E
xl/styles.xmlPK- �\@��� � � xl/sharedStrings.xmlPK � �