POST api/Messages
Creates a new mailing
Request Information
URI Parameters
None.
Body Parameters
MessageValues| Name | Description | Type | Additional information |
|---|---|---|---|
| Subject | string |
None. |
|
| Status | MessageStatus |
None. |
|
| UserID | globally unique identifier |
None. |
|
| MailingID | globally unique identifier |
None. |
|
| Text | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Subject": "sample string 1",
"Status": "Draft",
"UserID": "be35a73b-8461-4d6a-aa0e-71cb36455205",
"MailingID": "3c7b2097-5e71-4607-9cc6-c089cc5f689b",
"Text": "sample string 4"
}
application/xml, text/xml
Sample:
<MessageValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels"> <MailingID>3c7b2097-5e71-4607-9cc6-c089cc5f689b</MailingID> <Status>Draft</Status> <Subject>sample string 1</Subject> <Text>sample string 4</Text> <UserID>be35a73b-8461-4d6a-aa0e-71cb36455205</UserID> </MessageValues>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Subject" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" Draft --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="UserID" be35a73b-8461-4d6a-aa0e-71cb36455205 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MailingID" 3c7b2097-5e71-4607-9cc6-c089cc5f689b --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Text" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
MessageDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageID | globally unique identifier |
None. |
|
| Subject | string |
None. |
|
| Status | MessageStatus |
None. |
|
| User | UserPreview |
None. |
|
| Mailing | MailingPreview |
None. |
|
| Text | string |
None. |
|
| CreatedAt | date |
None. |
|
| CreatedBy | string |
None. |
|
| ModifiedAt | date |
None. |
|
| ModifiedBy | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"MessageID": "5fb6ccf7-7f71-4533-b418-232c2029b68a",
"Subject": "sample string 2",
"Status": "Draft",
"User": {
"UserID": "8379f0a7-f7e1-4ec9-a285-036272c999ca",
"FullName": "sample string 2",
"Type": "Operator",
"Role": "User",
"EmailAddress": "sample string 3",
"PhoneNumber": "sample string 4",
"LinkedObjectName": "sample string 5",
"LinkedObjectID": "sample string 6",
"Status": "InActive",
"IsSubscribed": true
},
"Mailing": {
"MailingID": "31da200c-bbc6-4df1-9e3f-62b38ec893a3",
"Title": "sample string 2",
"Status": "InActive",
"Type": "OfferPromo",
"ScheduledAt": "2026-06-28T12:09:54.018623Z"
},
"Text": "sample string 3",
"CreatedAt": "2026-06-28T12:09:54.018623Z",
"CreatedBy": "sample string 5",
"ModifiedAt": "2026-06-28T12:09:54.018623Z",
"ModifiedBy": "sample string 7"
}
application/xml, text/xml
Sample:
<MessageDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels">
<CreatedAt>2026-06-28T12:09:54.018623+00:00</CreatedAt>
<CreatedBy>sample string 5</CreatedBy>
<Mailing>
<MailingID>31da200c-bbc6-4df1-9e3f-62b38ec893a3</MailingID>
<ScheduledAt>2026-06-28T12:09:54.018623+00:00</ScheduledAt>
<Status>InActive</Status>
<Title>sample string 2</Title>
<Type>OfferPromo</Type>
</Mailing>
<MessageID>5fb6ccf7-7f71-4533-b418-232c2029b68a</MessageID>
<ModifiedAt>2026-06-28T12:09:54.018623+00:00</ModifiedAt>
<ModifiedBy>sample string 7</ModifiedBy>
<Status>Draft</Status>
<Subject>sample string 2</Subject>
<Text>sample string 3</Text>
<User>
<EmailAddress>sample string 3</EmailAddress>
<FullName>sample string 2</FullName>
<IsSubscribed>true</IsSubscribed>
<LinkedObjectID>sample string 6</LinkedObjectID>
<LinkedObjectName>sample string 5</LinkedObjectName>
<PhoneNumber>sample string 4</PhoneNumber>
<Role>User</Role>
<Status>InActive</Status>
<Type>Operator</Type>
<UserID>8379f0a7-f7e1-4ec9-a285-036272c999ca</UserID>
</User>
</MessageDetail>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MessageID" 5fb6ccf7-7f71-4533-b418-232c2029b68a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Subject" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" Draft --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.UserID" 8379f0a7-f7e1-4ec9-a285-036272c999ca --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.FullName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.Type" Operator --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.Role" User --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.EmailAddress" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.PhoneNumber" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.LinkedObjectName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.LinkedObjectID" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="User.IsSubscribed" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Mailing.MailingID" 31da200c-bbc6-4df1-9e3f-62b38ec893a3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Mailing.Title" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Mailing.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Mailing.Type" OfferPromo --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Mailing.ScheduledAt" 2026-06-28T12:09:54.0186230+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Text" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedAt" 2026-06-28T12:09:54.0186230+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedBy" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedAt" 2026-06-28T12:09:54.0186230+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedBy" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e--