PUT api/Messages/{id}

Updates an mailing

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

MessageValues
NameDescriptionTypeAdditional 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": "b4d6b7ff-fd20-42a4-bec6-ce563655cb45",
  "MailingID": "b4bf32bd-b357-492f-8f28-e95d4e6ccf1f",
  "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>b4bf32bd-b357-492f-8f28-e95d4e6ccf1f</MailingID>
  <Status>Draft</Status>
  <Subject>sample string 1</Subject>
  <Text>sample string 4</Text>
  <UserID>b4d6b7ff-fd20-42a4-bec6-ce563655cb45</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"

b4d6b7ff-fd20-42a4-bec6-ce563655cb45
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MailingID"

b4bf32bd-b357-492f-8f28-e95d4e6ccf1f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Text"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

MessageDetail
NameDescriptionTypeAdditional 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": "fb6d579d-3b6c-46db-822e-ef00e75a6b6b",
  "Subject": "sample string 2",
  "Status": "Draft",
  "User": {
    "UserID": "9abba883-0118-403b-9a74-1e65f3270c3a",
    "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": "6a2453ac-31aa-4ea4-89c8-e34fcafa4d20",
    "Title": "sample string 2",
    "Status": "InActive",
    "Type": "OfferPromo",
    "ScheduledAt": "2026-04-11T02:57:29.0567964Z"
  },
  "Text": "sample string 3",
  "CreatedAt": "2026-04-11T02:57:29.0567964Z",
  "CreatedBy": "sample string 5",
  "ModifiedAt": "2026-04-11T02:57:29.0567964Z",
  "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-04-11T02:57:29.0567964+00:00</CreatedAt>
  <CreatedBy>sample string 5</CreatedBy>
  <Mailing>
    <MailingID>6a2453ac-31aa-4ea4-89c8-e34fcafa4d20</MailingID>
    <ScheduledAt>2026-04-11T02:57:29.0567964+00:00</ScheduledAt>
    <Status>InActive</Status>
    <Title>sample string 2</Title>
    <Type>OfferPromo</Type>
  </Mailing>
  <MessageID>fb6d579d-3b6c-46db-822e-ef00e75a6b6b</MessageID>
  <ModifiedAt>2026-04-11T02:57:29.0567964+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>9abba883-0118-403b-9a74-1e65f3270c3a</UserID>
  </User>
</MessageDetail>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MessageID"

fb6d579d-3b6c-46db-822e-ef00e75a6b6b
--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"

9abba883-0118-403b-9a74-1e65f3270c3a
--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"

6a2453ac-31aa-4ea4-89c8-e34fcafa4d20
--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-04-11T02:57:29.0567964+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Text"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2026-04-11T02:57:29.0567964+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2026-04-11T02:57:29.0567964+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e--