POST api/messages/sendmessage

Request Information

URI Parameters

None.

Body Parameters

MessageComposeModel
NameDescriptionTypeAdditional information
sender_email

string

None.

sender_display_name

string

None.

sender_account_id

globally unique identifier

None.

to

Collection of MessageRecipientModel

None.

cc

Collection of MessageRecipientModel

None.

bcc

Collection of MessageRecipientModel

None.

importance

MessageImportance

None.

message_id

string

None.

references

string

None.

body

string

None.

attachments

Collection of globally unique identifier

None.

parent_id

globally unique identifier

None.

created_date

date

None.

send

boolean

None.

subject

string

None.

can_delete

boolean

None.

id

globally unique identifier

None.

subscription_id

globally unique identifier

None.

ts

Collection of byte

None.

Request Formats

application/json, text/json

Sample:
{
  "sender_email": "sample string 1",
  "sender_display_name": "sample string 2",
  "sender_account_id": "9d4f7729-2cfa-423b-803a-b86b007eb71b",
  "to": [
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "18b55864-9b71-47af-867c-288cab26722d"
    },
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "18b55864-9b71-47af-867c-288cab26722d"
    }
  ],
  "cc": [
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "18b55864-9b71-47af-867c-288cab26722d"
    },
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "18b55864-9b71-47af-867c-288cab26722d"
    }
  ],
  "bcc": [
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "18b55864-9b71-47af-867c-288cab26722d"
    },
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "18b55864-9b71-47af-867c-288cab26722d"
    }
  ],
  "importance": 0,
  "message_id": "sample string 4",
  "references": "sample string 5",
  "body": "sample string 6",
  "attachments": [
    "c6877c9e-5438-4b22-b8e4-2ff905ce42fe",
    "1be8bfc6-6e7d-4e9a-b8cf-8357679804eb"
  ],
  "parent_id": "bbd4c0cf-f4d6-46ae-be79-78bd241465ea",
  "created_date": "2026-04-10T20:14:53.3667567+08:00",
  "send": true,
  "subject": "sample string 9",
  "can_delete": true,
  "id": "8d558133-8449-482a-a306-562b06d48e6f",
  "subscription_id": "8e514fc5-3008-44fe-a09d-aeb446430870",
  "ts": "QEA="
}

application/xml, text/xml

Sample:
<MessageComposeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models">
  <Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">8d558133-8449-482a-a306-562b06d48e6f</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">8e514fc5-3008-44fe-a09d-aeb446430870</SubscriptionId>
  <Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
  <CanDelete>true</CanDelete>
  <Subject>sample string 9</Subject>
  <Attachments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>c6877c9e-5438-4b22-b8e4-2ff905ce42fe</d2p1:guid>
    <d2p1:guid>1be8bfc6-6e7d-4e9a-b8cf-8357679804eb</d2p1:guid>
  </Attachments>
  <Bcc>
    <MessageRecipientModel>
      <AccountId>18b55864-9b71-47af-867c-288cab26722d</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
    <MessageRecipientModel>
      <AccountId>18b55864-9b71-47af-867c-288cab26722d</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
  </Bcc>
  <Body>sample string 6</Body>
  <Cc>
    <MessageRecipientModel>
      <AccountId>18b55864-9b71-47af-867c-288cab26722d</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
    <MessageRecipientModel>
      <AccountId>18b55864-9b71-47af-867c-288cab26722d</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
  </Cc>
  <CreatedDate>2026-04-10T20:14:53.3667567+08:00</CreatedDate>
  <Importance>Low</Importance>
  <MessageId>sample string 4</MessageId>
  <ParentId>bbd4c0cf-f4d6-46ae-be79-78bd241465ea</ParentId>
  <References>sample string 5</References>
  <Send>true</Send>
  <SenderAccountId>9d4f7729-2cfa-423b-803a-b86b007eb71b</SenderAccountId>
  <SenderDisplayName>sample string 2</SenderDisplayName>
  <SenderEmail>sample string 1</SenderEmail>
  <To>
    <MessageRecipientModel>
      <AccountId>18b55864-9b71-47af-867c-288cab26722d</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
    <MessageRecipientModel>
      <AccountId>18b55864-9b71-47af-867c-288cab26722d</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
  </To>
</MessageComposeModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.