UpdateMessages
Inputs (Array[] to update)
Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
BrickId | Guid | The BrickId (unique id) of the message. | Yes | New method in 2.24 |
Receiver | Guid | The receiver of the message. |
|
|
Subject | string | The subject of the message. |
|
|
Body | string | The body of the message. |
|
|
EventDate | DateTime | A date associated with the message. |
|
|
IsHTML | bool | If the body of the message contains html this should be set to true. |
|
|
IsRead | bool | If the message is read by the customer. |
|
|
IsPublic | bool | If the message is public. |
|
|
IsPromoted | bool | If the message is promoted i.e. shown on the account overview when the user logs in. |
|
|
Priority | string | Which priority the message should have. Allowed values are: "High", "Medium", "Low". |
|
|
Status | string | Which status the message should have. Allowed values are: "Created", "InProgress", "Done", "Closed". |
|
|
Outputs
Name | Type | Description | Available from version |
|---|---|---|---|
Entities | Array | All message in the request is returned along with each message BrickId and array of Errors per message |
|
Code examples
XML Example - Update Message Status
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://tempuri.org/" xmlns:s1="http://microsoft.com/wsdl/types/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/">
<soap:Body>
<UpdateMessages xmlns="http://tempuri.org/">
<req>
<Credentials>
<UserName>[Username]</UserName>
<Password>[Password]</Password>
</Credentials>
<identify>[Identifier]</identify>
<Entities>
<UpdateMessage>
<BrickId>
[Guid Id of the message]
</BrickId>
<IsRead>true</IsRead>
</UpdateMessage>
</Entities>
<Fields>
<BrickId>true</BrickId>
<IsRead>true</IsRead>
</Fields>
</req>
</UpdateMessages>
</soap:Body>
</soap:Envelope>
Blog stream
Create a blog post to share news and announcements with your team and company.