POST api/messages/sendmessage

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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": "1f76b1b9-7d73-4d8a-b57c-de7903df3ed8",
  "to": [
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "c293ae8b-d490-46c5-b0c2-44413a9139ab"
    },
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "c293ae8b-d490-46c5-b0c2-44413a9139ab"
    }
  ],
  "cc": [
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "c293ae8b-d490-46c5-b0c2-44413a9139ab"
    },
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "c293ae8b-d490-46c5-b0c2-44413a9139ab"
    }
  ],
  "bcc": [
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "c293ae8b-d490-46c5-b0c2-44413a9139ab"
    },
    {
      "display_name": "sample string 1",
      "email_address": "sample string 2",
      "account_id": "c293ae8b-d490-46c5-b0c2-44413a9139ab"
    }
  ],
  "importance": 0,
  "message_id": "sample string 4",
  "references": "sample string 5",
  "body": "sample string 6",
  "attachments": [
    "ed5cfbbd-b517-4f10-906f-cb11acf940f7",
    "6f9996bc-56fd-4181-a090-e0c20c68e6ac"
  ],
  "parent_id": "0c43b09b-3410-4af0-a6b6-98fa637a859f",
  "created_date": "2026-02-09T19:52:13.7877391+08:00",
  "send": true,
  "subject": "sample string 9",
  "can_delete": true,
  "id": "3e559c5b-e86a-47dc-ab56-428541f7583a",
  "subscription_id": "307547f3-baf8-4784-aab6-06353d4b214e",
  "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">3e559c5b-e86a-47dc-ab56-428541f7583a</Id>
  <SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">307547f3-baf8-4784-aab6-06353d4b214e</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>ed5cfbbd-b517-4f10-906f-cb11acf940f7</d2p1:guid>
    <d2p1:guid>6f9996bc-56fd-4181-a090-e0c20c68e6ac</d2p1:guid>
  </Attachments>
  <Bcc>
    <MessageRecipientModel>
      <AccountId>c293ae8b-d490-46c5-b0c2-44413a9139ab</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
    <MessageRecipientModel>
      <AccountId>c293ae8b-d490-46c5-b0c2-44413a9139ab</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
  </Bcc>
  <Body>sample string 6</Body>
  <Cc>
    <MessageRecipientModel>
      <AccountId>c293ae8b-d490-46c5-b0c2-44413a9139ab</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
    <MessageRecipientModel>
      <AccountId>c293ae8b-d490-46c5-b0c2-44413a9139ab</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
  </Cc>
  <CreatedDate>2026-02-09T19:52:13.7877391+08:00</CreatedDate>
  <Importance>Low</Importance>
  <MessageId>sample string 4</MessageId>
  <ParentId>0c43b09b-3410-4af0-a6b6-98fa637a859f</ParentId>
  <References>sample string 5</References>
  <Send>true</Send>
  <SenderAccountId>1f76b1b9-7d73-4d8a-b57c-de7903df3ed8</SenderAccountId>
  <SenderDisplayName>sample string 2</SenderDisplayName>
  <SenderEmail>sample string 1</SenderEmail>
  <To>
    <MessageRecipientModel>
      <AccountId>c293ae8b-d490-46c5-b0c2-44413a9139ab</AccountId>
      <DisplayName>sample string 1</DisplayName>
      <EmailAddress>sample string 2</EmailAddress>
    </MessageRecipientModel>
    <MessageRecipientModel>
      <AccountId>c293ae8b-d490-46c5-b0c2-44413a9139ab</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.