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": "73067954-43ed-4f1e-b2ba-c18e22e9e1fc",
"to": [
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "c188454f-3ac6-495c-869a-e3d255f3326a"
},
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "c188454f-3ac6-495c-869a-e3d255f3326a"
}
],
"cc": [
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "c188454f-3ac6-495c-869a-e3d255f3326a"
},
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "c188454f-3ac6-495c-869a-e3d255f3326a"
}
],
"bcc": [
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "c188454f-3ac6-495c-869a-e3d255f3326a"
},
{
"display_name": "sample string 1",
"email_address": "sample string 2",
"account_id": "c188454f-3ac6-495c-869a-e3d255f3326a"
}
],
"importance": 0,
"message_id": "sample string 4",
"references": "sample string 5",
"body": "sample string 6",
"attachments": [
"4d81cd73-e621-4f67-9a2b-dd1c79c17175",
"2c8ca046-7360-4646-b7a2-0db2116a8ddb"
],
"parent_id": "48e91789-1800-4af1-9d0f-a545216ab490",
"created_date": "2026-06-09T14:59:25.9028316+08:00",
"send": true,
"subject": "sample string 9",
"can_delete": true,
"id": "67160834-f076-41da-862e-3a1c72281b0d",
"subscription_id": "a5913244-a8f5-459d-9406-72ddf3711f67",
"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">67160834-f076-41da-862e-3a1c72281b0d</Id>
<SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">a5913244-a8f5-459d-9406-72ddf3711f67</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>4d81cd73-e621-4f67-9a2b-dd1c79c17175</d2p1:guid>
<d2p1:guid>2c8ca046-7360-4646-b7a2-0db2116a8ddb</d2p1:guid>
</Attachments>
<Bcc>
<MessageRecipientModel>
<AccountId>c188454f-3ac6-495c-869a-e3d255f3326a</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
<MessageRecipientModel>
<AccountId>c188454f-3ac6-495c-869a-e3d255f3326a</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
</Bcc>
<Body>sample string 6</Body>
<Cc>
<MessageRecipientModel>
<AccountId>c188454f-3ac6-495c-869a-e3d255f3326a</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
<MessageRecipientModel>
<AccountId>c188454f-3ac6-495c-869a-e3d255f3326a</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
</Cc>
<CreatedDate>2026-06-09T14:59:25.9028316+08:00</CreatedDate>
<Importance>Low</Importance>
<MessageId>sample string 4</MessageId>
<ParentId>48e91789-1800-4af1-9d0f-a545216ab490</ParentId>
<References>sample string 5</References>
<Send>true</Send>
<SenderAccountId>73067954-43ed-4f1e-b2ba-c18e22e9e1fc</SenderAccountId>
<SenderDisplayName>sample string 2</SenderDisplayName>
<SenderEmail>sample string 1</SenderEmail>
<To>
<MessageRecipientModel>
<AccountId>c188454f-3ac6-495c-869a-e3d255f3326a</AccountId>
<DisplayName>sample string 1</DisplayName>
<EmailAddress>sample string 2</EmailAddress>
</MessageRecipientModel>
<MessageRecipientModel>
<AccountId>c188454f-3ac6-495c-869a-e3d255f3326a</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.