POST api/message
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": "IJh32OsFh0m7NtTcgHXeuQ==",
"identifierGuid": "d8779820-05eb-4987-bb36-d4dc8075deb9",
"priority": 2,
"createdUtc": "2026-04-03T06:24:32.3506083",
"receivedUtc": "2026-04-03T06:24:32.3506083",
"rsvpUtc": "2026-04-03T06:24:32.3506083",
"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": [
"64ab1862-4761-488a-a5e5-c29fa10c6207",
"3b11f733-ee61-4ed1-b067-5ad91b665454"
],
"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:32.3506083+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>IJh32OsFh0m7NtTcgHXeuQ==</Identifier>
<IdentifierGuid>d8779820-05eb-4987-bb36-d4dc8075deb9</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>64ab1862-4761-488a-a5e5-c29fa10c6207</d2p1:guid>
<d2p1:guid>3b11f733-ee61-4ed1-b067-5ad91b665454</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-04-03T06:24:32.3506083+00:00</ReceivedUtc>
<RsvpUtc>2026-04-03T06:24:32.3506083+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:
"8a1e5ee2-f2ca-4d57-a45d-ba84272a30a6"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8a1e5ee2-f2ca-4d57-a45d-ba84272a30a6</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 3�\`�'B� 5 xl/workbook.xml � (� ����0D�&�C���#)��x��})[i�-ik��-H�yۙ�};|��o���G���]c��j�';��;i���{1+�X[��h;'I��5�S��+��B�;Ġ��AZ���S�����l���o�/��bQĀƒ���Ź�%M)q���#El.rq�iv���������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�\{Pd' ' _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="R15754d9201a54068" /></Relationships>PK 3�\����$ � xl/worksheets/sheet1.xml � (� �Q�n� ��}%i״��T��j�M;lg�85�Ȑ��? �4i� [~~�ٔ���4ڊ盌3�
����|�p��\�nNx�֝�����$�k�68�
��HR�v�n��d�z�ͲB�)������.7�6Y0�Je���.[أ{F�U�)�L�eB�kXܯ��1>o1yi+�%���&�Wb-tr�.Ϡ{�Æ��������ƙ���.�����&��c�=d����fr��Z]M��%I^��uI�0J�@�8�KF����uV�9������~�tE�@I����/PK 3�\T u�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8NL���ݰa[z��3��&vd�@�Ƃ#q�"A*�`��h~OO��|���ަ�����
�,FV�n�}���j�m7{1��`�9��bC&����M27�M���1���3�#�ċ<_q�d�5��3���=:u���?����c0D�}O���R� �D��5�Dm�p��Z�
%0~3��#�_��|!�՚(�uW�B"u7�1�{�>]z�,/�T�e^��hK)���Ư�b�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�0E�b��uj�6B��@�p�!�6��q�L��`�������]V�E����Ȍ ��^�F9�Z�&�!s�ADM��L��n��ɼPA9Ս�%��Ԇ��ɶ&Y����w���f�kӂ98���M�c�8�"o�~Fۧ�j������W�O^���_ߵW�PK- 3�\`�'B� 5 xl/workbook.xmlPK- 3�\���� � � [Content_Types].xmlPK-
3�\{Pd' ' U _rels/.relsPK- 3�\����$ � � xl/worksheets/sheet1.xmlPK- 3�\T u�� P 7 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
} xl/styles.xmlPK- 3�\��`.� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK 3�\gW��� 5 xl/workbook.xml � (� ����0D�&�C��(H")��x�པEh�ik��H�yۙ�};|B74��������yك��̼��if�^�NI�Q�5��.I�3�
���t����ցh}���P�V�!|i�T0�(gc�����!����_DE��P�ZAIt�mIϔ�B�ãMy��L�W�5��;{�q����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�\Z`�V' ' _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="R0d62dbb2c5f745c6" /></Relationships>PK 3�\����$ � xl/worksheets/sheet1.xml � (� �Q�n� ��}%i״��T��j�M;lg�85�Ȑ��? �4i� [~~�ٔ���4ڊ盌3�
����|�p��\�nNx�֝�����$�k�68�
��HR�v�n��d�z�ͲB�)������.7�6Y0�Je���.[أ{F�U�)�L�eB�kXܯ��1>o1yi+�%���&�Wb-tr�.Ϡ{�Æ��������ƙ���.�����&��c�=d����fr��Z]M��%I^��uI�0J�@�8�KF����uV�9������~�tE�@I����/PK 3�\����� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8I�|��ݰa[zg2��&vd�@�Ƃ#q�"A*�`��h~OO��|���ߦ����5
dI
��n0}�*��e�^�gq��t�s��&�;��e�$CL]�g�'��Ӵ�nɀ[&;^f��*5 =Z<Od�`�j��k� �(]O�����א%�
�k�ЭZ�U!p�FѶ��M͇�H���;_����u�J%�UvW-u���K/��党j%VJ�u���UyU�7��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�0E�b��uj�6B��@�p�!�6��q�L��`�������]V�E����Ȍ ��^�F9�Z�&�!s�ADM��L��n��ɼPA9Ս�%��Ԇ��ɶ&Y����w���f�kӂ98���M�c�8�"o�~Fۧ�j������W�O^���_ߵW�PK- 3�\gW��� 5 xl/workbook.xmlPK- 3�\���� � � [Content_Types].xmlPK-
3�\Z`�V' ' U _rels/.relsPK- 3�\����$ � � xl/worksheets/sheet1.xmlPK- 3�\����� P 7 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
~ xl/styles.xmlPK- 3�\��`.� � � xl/sharedStrings.xmlPK � �