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": "ZfymVzLh00mZMxghOAIrrw==",
"identifierGuid": "57a6fc65-e132-49d3-9933-182138022baf",
"priority": 2,
"createdUtc": "2026-04-03T06:20:26.0430416",
"receivedUtc": "2026-04-03T06:20:26.0430416",
"rsvpUtc": "2026-04-03T06:20:26.0430416",
"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": [
"560713d9-1d89-4671-b9bb-270da5612f75",
"955d5148-b942-4489-9de7-91534f4cc0be"
],
"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:20:26.0430416+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>ZfymVzLh00mZMxghOAIrrw==</Identifier>
<IdentifierGuid>57a6fc65-e132-49d3-9933-182138022baf</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>560713d9-1d89-4671-b9bb-270da5612f75</d2p1:guid>
<d2p1:guid>955d5148-b942-4489-9de7-91534f4cc0be</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-04-03T06:20:26.0430416+00:00</ReceivedUtc>
<RsvpUtc>2026-04-03T06:20:26.0430416+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:
"ae892684-53d7-4c72-8878-a668944d93b3"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">ae892684-53d7-4c72-8878-a668944d93b3</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �2�\� 5 xl/workbook.xml � (� ��;�0D�H����!~*��)�;f,�G�#r�#�ҥۙ�};͢���zB9+W��ޛ��F��]�v\[I}��E4�A��[���$9�0S/�r�0o�X�X����7��B��|B�Y�=,.�`�uW�-D~SM�Q!E%����b����#[�0�sV �U��i�ee��k����PK �2�\���� � [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
�2�\�;��' ' _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="R82a27fb68afe44f5" /></Relationships>PK �2�\�} % � xl/worksheets/sheet1.xml � (� �Q�N�0���w�n��Lm'�i�� �кM�&��t�瓤!q�Ė��{v��M���)25l704-u�5̾�+��Tً����q[��~:p�Z�Z�
MhB�'���8��j�D��x�˲�[�RN�����.7Y]��ǕJe��:أ{f���i�7UB�+\ܯ��1>�.1y�j������e�b�-Ϩ�Æ������ʹ�{��-��꼬a_n�|�P����"�큵��?��꒯4I�$�h*K���c�q�iwa�k�U�{� �o�k�[B{&�h����5_PK �2�\�N�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�Q���ݰ��gGM��v=�����ĂMW��==i���c�}�Fv&g�� FV�n�}��*�n�{1��`�9��bC&����M27�M���1���3�#��s!V�/p�d��L�!:�E�N�&��0u�Qv@�Sl��5�,Q���+U��u)������x)�z}��QI�K-
Y˻��ԽD�.�tZ�ju��H�|DQؖW5~��/PK �2�\Ѓ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 �2�\��♮ � xl/sharedStrings.xml � (� 5�AN�0�b��됄�A���/��x�X��!3Y��1���V��~�M=��Th��K
i)1�}���WmA��a+�3� ��z�,�N�gXE�cxY1���&���A*w���!�(y3m�&�D��r�T-���������vj���.��_�V[;Z��N}��sF�3}S_�_PK- �2�\� 5 xl/workbook.xmlPK- �2�\���� � [Content_Types].xmlPK-
�2�\�;��' ' V _rels/.relsPK- �2�\�} % � � xl/worksheets/sheet1.xmlPK- �2�\�N�� P 9 xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
~ xl/styles.xmlPK- �2�\��♮ � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK �2�\���8� 5 xl/workbook.xml � (� ����0��&�C��`P )��x��})�m�?ik���'�x�3;��������'=�P���]�X5��uh�]g��8I�b���ڊ�F�9I��� QY�r���X�y�6HĨ��AZ���S�9[��$l
��_`���%�!%�soK�R�5
�4LE�6�6�n"�;{�q����PK �2�\���� � [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
�2�\)�2�' ' _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="R55336eac5baf4371" /></Relationships>PK �2�\�} % � xl/worksheets/sheet1.xml � (� �Q�N�0���w�n��Lm'�i�� �кM�&��t�瓤!q�Ė��{v��M���)25l704-u�5̾�+��Tً����q[��~:p�Z�Z�
MhB�'���8��j�D��x�˲�[�RN�����.7Y]��ǕJe��:أ{f���i�7UB�+\ܯ��1>�.1y�j������e�b�-Ϩ�Æ������ʹ�{��-��꼬a_n�|�P����"�큵��?��꒯4I�$�h*K���c�q�iwa�k�U�{� �o�k�[B{&�h����5_PK �2�\�* �� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8n�Vu�aö���Q;�]�gc���V���X��j4��'�|�lvo�H^0��;����S^�pJ殃�v��Q�<�0G�W\`S�הFeq���3��1>L2�4�t��({������d�5��3���>xu�Х?��Շc�� �A����R����L��Y'���=����@���b:����BFִ�%oVR���2V�O)�K�Ne�PkV���Ѻ�̰�����PK �2�\Ѓ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 �2�\��♮ � xl/sharedStrings.xml � (� 5�AN�0�b��됄�A���/��x�X��!3Y��1���V��~�M=��Th��K
i)1�}���WmA��a+�3� ��z�,�N�gXE�cxY1���&���A*w���!�(y3m�&�D��r�T-���������vj���.��_�V[;Z��N}��sF�3}S_�_PK- �2�\���8� 5 xl/workbook.xmlPK- �2�\���� � � [Content_Types].xmlPK-
�2�\)�2�' ' U _rels/.relsPK- �2�\�} % � � xl/worksheets/sheet1.xmlPK- �2�\�* �� P 8 xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
| xl/styles.xmlPK- �2�\��♮ � � xl/sharedStrings.xmlPK � �