POST api/Email

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EmailId	string	None.
PortalCustomersId	string	None.
PortalUsersId	string	None.
ExternalEmailId	string	None.
UserName	string	None.
SubjectLine	string	None.
RedirectURL	string	None.
EmailAddress	string	None.
TransactionType	string	None.
LogDate	date	None.
EmailClientVersion	string	None.
EmailClient	string	None.
Alerts	string	None.
HitCount	integer	None.
LastImpression	date	None.
textBody	string	None.
BodyText	string	None.
EmailTemplateId	string	None.
IPAddress	string	None.
CRMID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "EmailId": "sample string 1",
  "PortalCustomersId": "sample string 2",
  "PortalUsersId": "sample string 3",
  "ExternalEmailId": "sample string 4",
  "UserName": "sample string 5",
  "SubjectLine": "sample string 6",
  "RedirectURL": "sample string 7",
  "EmailAddress": "sample string 8",
  "TransactionType": "sample string 9",
  "LogDate": "2025-12-14T22:25:57.3937058+00:00",
  "EmailClientVersion": "sample string 11",
  "EmailClient": "sample string 12",
  "Alerts": "sample string 13",
  "HitCount": 14,
  "LastImpression": "2025-12-14T22:25:57.3937058+00:00",
  "textBody": "sample string 16",
  "BodyText": "sample string 17",
  "EmailTemplateId": "sample string 18",
  "IPAddress": "sample string 19",
  "CRMID": "sample string 20"
}

application/xml, text/xml

Sample:

<Email xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <Alerts>sample string 13</Alerts>
  <BodyText>sample string 17</BodyText>
  <CRMID>sample string 20</CRMID>
  <EmailAddress>sample string 8</EmailAddress>
  <EmailClient>sample string 12</EmailClient>
  <EmailClientVersion>sample string 11</EmailClientVersion>
  <EmailId>sample string 1</EmailId>
  <EmailTemplateId>sample string 18</EmailTemplateId>
  <ExternalEmailId>sample string 4</ExternalEmailId>
  <HitCount>14</HitCount>
  <IPAddress>sample string 19</IPAddress>
  <LastImpression>2025-12-14T22:25:57.3937058+00:00</LastImpression>
  <LogDate>2025-12-14T22:25:57.3937058+00:00</LogDate>
  <PortalCustomersId>sample string 2</PortalCustomersId>
  <PortalUsersId>sample string 3</PortalUsersId>
  <RedirectURL>sample string 7</RedirectURL>
  <SubjectLine>sample string 6</SubjectLine>
  <TransactionType>sample string 9</TransactionType>
  <UserName>sample string 5</UserName>
  <textBody>sample string 16</textBody>
</Email>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseService

Name	Type	Additional information
validRequest	boolean	None.
RequestMessage	string	None.
EntityName	string	None.
EntityId	string	None.
URL	string	None.
APIVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "validRequest": true,
  "RequestMessage": "sample string 2",
  "EntityName": "sample string 3",
  "EntityId": "sample string 4",
  "URL": "sample string 5",
  "APIVersion": "sample string 6"
}

application/xml, text/xml

Sample:

<ResponseService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <APIVersion>sample string 6</APIVersion>
  <EntityId>sample string 4</EntityId>
  <EntityName>sample string 3</EntityName>
  <RequestMessage>sample string 2</RequestMessage>
  <URL>sample string 5</URL>
  <validRequest>true</validRequest>
</ResponseService>