POST api/Encode
Request Information
URI Parameters
None.
Body Parameters
SendCastPlugIn| Name | Description | Type | Additional information |
|---|---|---|---|
| EmailToList | string |
None. |
|
| SubjectLine | string |
None. |
|
| BodyHTML | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"EmailToList": "sample string 1",
"SubjectLine": "sample string 2",
"BodyHTML": "sample string 3"
}
application/xml, text/xml
Sample:
<SendCastPlugIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage"> <BodyHTML>sample string 3</BodyHTML> <EmailToList>sample string 1</EmailToList> <SubjectLine>sample string 2</SubjectLine> </SendCastPlugIn>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SendCastRecipient| Name | Description | Type | Additional information |
|---|---|---|---|
| SendCastRecipientId | string |
None. |
|
| PortalCustomersId | string |
None. |
|
| SendCastAutomationId | string |
None. |
|
| SendCastHeaderId | string |
None. |
|
| SendCastQueueId | string |
None. |
|
| ListsRecipientsId | string |
None. |
|
| EmailAddress | string |
None. |
|
| CRMId | string |
None. |
|
| Subject | string |
None. |
|
| FromEmail | string |
None. |
|
| DisplayName | string |
None. |
|
| SendCastDate | date |
None. |
|
| SendCastRecipientState | string |
None. |
|
| ABSource | string |
None. |
|
| CRMHistoryId | string |
None. |
|
| _Body | string |
None. |
|
| _BodyText | string |
None. |
|
| _RecipientDisplayName | string |
None. |
|
| _ReplyToAddress | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"SendCastRecipientId": "sample string 1",
"PortalCustomersId": "sample string 2",
"SendCastAutomationId": "sample string 3",
"SendCastHeaderId": "sample string 4",
"SendCastQueueId": "sample string 5",
"ListsRecipientsId": "sample string 6",
"EmailAddress": "sample string 7",
"CRMId": "sample string 8",
"Subject": "sample string 9",
"FromEmail": "sample string 10",
"DisplayName": "sample string 11",
"SendCastDate": "2025-12-14T22:34:45.0202369+00:00",
"SendCastRecipientState": "sample string 13",
"ABSource": "sample string 14",
"CRMHistoryId": "sample string 15",
"_Body": "sample string 16",
"_BodyText": "sample string 17",
"_RecipientDisplayName": "sample string 18",
"_ReplyToAddress": "sample string 19"
}
application/xml, text/xml
Sample:
<SendCastRecipient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage"> <ABSource>sample string 14</ABSource> <CRMHistoryId>sample string 15</CRMHistoryId> <CRMId>sample string 8</CRMId> <DisplayName>sample string 11</DisplayName> <EmailAddress>sample string 7</EmailAddress> <FromEmail>sample string 10</FromEmail> <ListsRecipientsId>sample string 6</ListsRecipientsId> <PortalCustomersId>sample string 2</PortalCustomersId> <SendCastAutomationId>sample string 3</SendCastAutomationId> <SendCastDate>2025-12-14T22:34:45.0202369+00:00</SendCastDate> <SendCastHeaderId>sample string 4</SendCastHeaderId> <SendCastQueueId>sample string 5</SendCastQueueId> <SendCastRecipientId>sample string 1</SendCastRecipientId> <SendCastRecipientState>sample string 13</SendCastRecipientState> <Subject>sample string 9</Subject> <_Body>sample string 16</_Body> <_BodyText>sample string 17</_BodyText> <_RecipientDisplayName>sample string 18</_RecipientDisplayName> <_ReplyToAddress>sample string 19</_ReplyToAddress> </SendCastRecipient>