POST api/messages/sendmessage
Request Information
URI Parameters
None.
Body Parameters
MessageComposeModel| Name | Description | 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": "58499ed7-cb45-46ce-a3a7-9d1482895d86",
"to": [
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "e49f855e-c662-4be4-8056-506b1216a827"
},
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "e49f855e-c662-4be4-8056-506b1216a827"
}
],
"cc": [
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "e49f855e-c662-4be4-8056-506b1216a827"
},
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "e49f855e-c662-4be4-8056-506b1216a827"
}
],
"bcc": [
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "e49f855e-c662-4be4-8056-506b1216a827"
},
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "e49f855e-c662-4be4-8056-506b1216a827"
}
],
"importance": 0,
"message_id": "sample string 4",
"references": "sample string 5",
"body": "sample string 6",
"attachments": [
"fc70a79d-9087-4266-aa98-5661bb9952ef",
"2a26c445-570c-4bd0-beff-a9358c7ee1d1"
],
"parent_id": "1a8f3756-f14b-46a0-ab28-21c1f00e32b8",
"created_date": "2026-10-08T19:16:45.8838446+08:00",
"send": true,
"subject": "sample string 9",
"can_delete": true,
"id": "4487e3c5-b452-4378-9e7d-b57be50944af",
"subscription_id": "f195f885-101e-4860-9b1f-cc2b99805450",
"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">4487e3c5-b452-4378-9e7d-b57be50944af</Id>
<SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">f195f885-101e-4860-9b1f-cc2b99805450</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>fc70a79d-9087-4266-aa98-5661bb9952ef</d2p1:guid>
<d2p1:guid>2a26c445-570c-4bd0-beff-a9358c7ee1d1</d2p1:guid>
</Attachments>
<Bcc>
<MessageRecipientModel>
<AccountId>e49f855e-c662-4be4-8056-506b1216a827</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
<MessageRecipientModel>
<AccountId>e49f855e-c662-4be4-8056-506b1216a827</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
</Bcc>
<Body>sample string 6</Body>
<Cc>
<MessageRecipientModel>
<AccountId>e49f855e-c662-4be4-8056-506b1216a827</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
<MessageRecipientModel>
<AccountId>e49f855e-c662-4be4-8056-506b1216a827</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
</Cc>
<CreatedDate>2026-10-08T19:16:45.8838446+08:00</CreatedDate>
<Importance>Low</Importance>
<MessageId>sample string 4</MessageId>
<ParentId>1a8f3756-f14b-46a0-ab28-21c1f00e32b8</ParentId>
<References>sample string 5</References>
<Send>true</Send>
<SenderAccountId>58499ed7-cb45-46ce-a3a7-9d1482895d86</SenderAccountId>
<SenderDisplayName>sample string 2</SenderDisplayName>
<SenderEmail>sample string 1</SenderEmail>
<To>
<MessageRecipientModel>
<AccountId>e49f855e-c662-4be4-8056-506b1216a827</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
<MessageRecipientModel>
<AccountId>e49f855e-c662-4be4-8056-506b1216a827</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
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.