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": "eqdJQeLsHk66dNdXV/cCAg==",
"identifierGuid": "4149a77a-ece2-4e1e-ba74-d75757f70202",
"priority": 2,
"createdUtc": "2026-06-03T18:29:47.8899738",
"receivedUtc": "2026-06-03T18:29:47.8899738",
"rsvpUtc": "2026-06-03T18:29:47.8899738",
"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": [
"f0f8ea90-6a77-4a75-a0bf-111e9532133b",
"890530fc-7b3e-4bf6-8e54-a9f64fd62dd4"
],
"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:29:47.8899738+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>eqdJQeLsHk66dNdXV/cCAg==</Identifier>
<IdentifierGuid>4149a77a-ece2-4e1e-ba74-d75757f70202</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>f0f8ea90-6a77-4a75-a0bf-111e9532133b</d2p1:guid>
<d2p1:guid>890530fc-7b3e-4bf6-8e54-a9f64fd62dd4</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-06-03T18:29:47.8899738+00:00</ReceivedUtc>
<RsvpUtc>2026-06-03T18:29:47.8899738+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:
"88e04419-a33b-4cc6-ad08-23a9f3dfa897"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">88e04419-a33b-4cc6-ad08-23a9f3dfa897</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK ���\,�qw� 5 xl/workbook.xml � (� ����0��&�C���`")��x��Э4П�5���H�yۙ��v�l��3�����\��lE��P̟�w�8�B��E�����o:��|��h?H��J����� Դ��7�Bti��0�$���]LD��M��/�B�)�q��(9w^�#W�8<@�+�_J^d���F����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
���\l!K' ' _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="R2cd00bc3dcb14477" /></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η��vÆm��xGM��v���G�
XE�Tb�������4����ݿM#yAg9�,��sj�=�s�+��EL�s i�&�yCi�N"dnF�:��IĔ��;�i��
�K�2��2��N��Gם'��0}u�br�����5�,Q�<)ԕ�U!UY���k �nj!^F�^��B�T�d�h�5�J��2FxT�ѧK/��党X�m��R���k�j��/v_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 ���\u��� � xl/sharedStrings.xml � (� 5�An� E���Hl���dQ)'H0�q�d׃�����.���z�]�y�8��`�@
%&����vUV
�@�B8��hS�Qε��Zs�1ʊԒ�lj��y�"ψ5/�d�YgH$E(;զ�b����?7A�zk���qP�u?�� �NS'�Ç��;����PK- ���\,�qw� 5 xl/workbook.xmlPK- ���\���� � [Content_Types].xmlPK-
���\l!K' ' V _rels/.relsPK- ���\T$��$ � � xl/worksheets/sheet1.xmlPK- ���\��� P 8 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
~ xl/styles.xmlPK- ���\u��� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK ���\�0E� 5 xl/workbook.xml � (� ����0��&�C���`cH��ū�l������Ƿ�@�������&���}�hB�+���JB��A�p�L�I�5�I��R*�o
&���H���GeM�x���
��B���4W��Bln�T0�,��֝MD��M��.�B�k�p�#�(;���'�|���mA)\�]A�7�{�1����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="R50b31f1a5cc24a0d" /></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͞8M���ݰa[z�'Q۲]�gc���V���X��j4��'�|���o�L^ЇɚVE ��j2C���Z�n�;�ELa�\ iń���A���PX�&u����)�uBŀ�*KN}k&ٟ��h��$>ZyZ��?����c#����~J�^ªHT O���>0αn��d�@���B<�~���L�W�fR��w�*�o*3
��9�t��)/gju���݁�-k:}Q�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 ���\u��� � xl/sharedStrings.xml � (� 5�An� E���Hl���dQ)'H0�q�d׃�����.���z�]�y�8��`�@
%&����vUV
�@�B8��hS�Qε��Zs�1ʊԒ�lj��y�"ψ5/�d�YgH$E(;զ�b����?7A�zk���qP�u?�� �NS'�Ç��;����PK- ���\�0E� 5 xl/workbook.xmlPK- ���\���� � � [Content_Types].xmlPK-
���\���' ' U _rels/.relsPK- ���\T$��$ � � xl/worksheets/sheet1.xmlPK- ���\Ƈ��� P 7 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
} xl/styles.xmlPK- ���\u��� � � xl/sharedStrings.xmlPK � �