PUT example/api/MailMessage/{id}
https://app.bwz.se/bedrock/example/api/MailMessage/{id}
Updates a MailMessageModel.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Id of the MailMessageModel to update. |
integer |
Required |
Body Parameters
Preheader text of the MailMessage
UpdateMailMessageArgsName | Description | Type | Additional information |
---|---|---|---|
Name |
Sets the name. |
string |
Valid name with max 256 characters |
PublicationId |
Sets the publications id. |
integer |
None. |
Description |
Sets the description. |
string |
None. |
SenderName |
Sets the name of the sender. |
string |
None. |
SenderEmail |
Sets the e-mail address of the sender. |
string |
Empty or a valid email adress |
ReplyTo |
Sets the reply-to address. |
string |
Empty or a valid email adress |
Subject |
Sets the subject. |
string |
None. |
ScheduledSendDate |
Sets date and time when the MailMessage will be sent. |
date |
None. |
Preheader |
Preheader text of the MailMessage |
string |
None. |
Request Formats
application/json, text/json
{ "Name": "sample string 1", "PublicationId": 1, "Description": "sample string 2", "SenderName": "sample string 3", "SenderEmail": "sample string 4", "ReplyTo": "sample string 5", "Subject": "sample string 6", "ScheduledSendDate": "2024-12-23T06:23:46.4348059+01:00", "Preheader": "sample string 7" }
application/xml, text/xml
<UpdateMailMessageArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailMessage"> <Description>sample string 2</Description> <Name>sample string 1</Name> <Preheader>sample string 7</Preheader> <PublicationId>1</PublicationId> <ReplyTo>sample string 5</ReplyTo> <ScheduledSendDate>2024-12-23T06:23:46.4348059+01:00</ScheduledSendDate> <SenderEmail>sample string 4</SenderEmail> <SenderName>sample string 3</SenderName> <Subject>sample string 6</Subject> </UpdateMailMessageArgs>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The updated MailMessageModel.
MailMessageModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Id of the MailMessage. |
integer |
None. |
Name |
Name of the MailMessage. |
string |
None. |
CreatedByUserId |
Id of the User creating the MailMessage. |
integer |
None. |
MessageStatus |
The MessageStatus of the MailMessage. |
MessageStatus |
None. |
CreationDate |
Date and time when the MailMessage was created. |
date |
None. |
ModifiedDate |
Date and time when the MailMessage was last modified. |
date |
None. |
PublicationId |
Id the of Publication the MailMessage belongs to. |
integer |
None. |
Description |
Description of the MailMessage. |
string |
None. |
SenderName |
Sender name of the MailMessage. |
string |
None. |
SenderEmail |
Email address of the sender of the MailMessage. |
string |
None. |
ReplyTo |
Reply-to address of the MailMessage. |
string |
None. |
Subject |
Subject of the MailMessage. |
string |
None. |
UseStatistics |
A flag indicating if the MailMessage will gather statistics when sent. |
boolean |
None. |
HtmlContentId |
Id of the Content holding the HTML content of the MailMessage. |
integer |
None. |
TextContentId |
Id of the Content holding the text content of the MailMessage. |
integer |
None. |
ScheduledSendDate |
Date and time when the MailMessage will be sent. |
date |
None. |
MailTemplateId |
Id of the MailTemplate used for the MailMessage |
integer |
None. |
Preheader |
Preheader text of the MailMessage |
string |
None. |
Response Formats
application/json, text/json
{ "Id": 1, "Name": "sample string 2", "CreatedByUserId": 3, "MessageStatus": 0, "CreationDate": "2024-12-23T06:23:46.4348059+01:00", "ModifiedDate": "2024-12-23T06:23:46.4348059+01:00", "PublicationId": 6, "Description": "sample string 7", "SenderName": "sample string 8", "SenderEmail": "sample string 9", "ReplyTo": "sample string 10", "Subject": "sample string 11", "UseStatistics": true, "HtmlContentId": 1, "TextContentId": 1, "ScheduledSendDate": "2024-12-23T06:23:46.4348059+01:00", "MailTemplateId": 1, "Preheader": "sample string 13" }
application/xml, text/xml
<MailMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailMessage"> <CreatedByUserId>3</CreatedByUserId> <CreationDate>2024-12-23T06:23:46.4348059+01:00</CreationDate> <Description>sample string 7</Description> <HtmlContentId>1</HtmlContentId> <Id>1</Id> <MailTemplateId>1</MailTemplateId> <MessageStatus>NotReadyToSend</MessageStatus> <ModifiedDate>2024-12-23T06:23:46.4348059+01:00</ModifiedDate> <Name>sample string 2</Name> <Preheader>sample string 13</Preheader> <PublicationId>6</PublicationId> <ReplyTo>sample string 10</ReplyTo> <ScheduledSendDate>2024-12-23T06:23:46.4348059+01:00</ScheduledSendDate> <SenderEmail>sample string 9</SenderEmail> <SenderName>sample string 8</SenderName> <Subject>sample string 11</Subject> <TextContentId>1</TextContentId> <UseStatistics>true</UseStatistics> </MailMessageModel>