POST 17.0/database/contactemails/list

Description

Retrieve a list of Contact Emails

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of ContactEmailsUpdate
Name Description Type Additional information
ID

integer

None.
ContactID

integer

None.
EmailID

integer

None.
Subject

string

String length: inclusive between 0 and 255
Body

string

None.
FileName

string

String length: inclusive between 0 and 255
UserID

integer

None.
PropertyID

integer

None.
WorkOrderID

integer

None.
PropertyOfferID

integer

None.
CertificateID

integer

None.
TenancyID

integer

None.
ContactTaskID

integer

None.
BatchID

integer

None.
Status

byte

None.
StatusDate

date

None.
Type

byte

None.
AlwaysShowAtTop

byte

None.
AddedDate

date

None.
LegacyAttachments

string

None.
HighPriority

byte

None.
ReadReceiptRequested

byte

None.
ExternalID

string

String length: inclusive between 0 and 100
EngagementID

string

String length: inclusive between 0 and 100

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "emailID": 1,
    "subject": "sample string 1",
    "body": "sample string 2",
    "fileName": "sample string 3",
    "userID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "tenancyID": 1,
    "contactTaskID": 1,
    "batchID": 1,
    "status": 64,
    "statusDate": "2025-01-09T20:39",
    "type": 64,
    "alwaysShowAtTop": 64,
    "addedDate": "2025-01-09T20:39",
    "legacyAttachments": "sample string 4",
    "highPriority": 64,
    "readReceiptRequested": 64,
    "externalID": "sample string 5",
    "engagementID": "sample string 6"
  },
  {
    "id": 1,
    "contactID": 1,
    "emailID": 1,
    "subject": "sample string 1",
    "body": "sample string 2",
    "fileName": "sample string 3",
    "userID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "propertyOfferID": 1,
    "certificateID": 1,
    "tenancyID": 1,
    "contactTaskID": 1,
    "batchID": 1,
    "status": 64,
    "statusDate": "2025-01-09T20:39",
    "type": 64,
    "alwaysShowAtTop": 64,
    "addedDate": "2025-01-09T20:39",
    "legacyAttachments": "sample string 4",
    "highPriority": 64,
    "readReceiptRequested": 64,
    "externalID": "sample string 5",
    "engagementID": "sample string 6"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactEmailsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactEmailsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <EmailID>1</EmailID>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <FileName>sample string 3</FileName>
    <UserID>1</UserID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <TenancyID>1</TenancyID>
    <ContactTaskID>1</ContactTaskID>
    <BatchID>1</BatchID>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:39:57.8281769+00:00</StatusDate>
    <Type>64</Type>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <AddedDate>2025-01-09T20:39:57.8281769+00:00</AddedDate>
    <LegacyAttachments>sample string 4</LegacyAttachments>
    <HighPriority>64</HighPriority>
    <ReadReceiptRequested>64</ReadReceiptRequested>
    <ExternalID>sample string 5</ExternalID>
    <EngagementID>sample string 6</EngagementID>
  </ContactEmailsUpdate>
  <ContactEmailsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <EmailID>1</EmailID>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <FileName>sample string 3</FileName>
    <UserID>1</UserID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <PropertyOfferID>1</PropertyOfferID>
    <CertificateID>1</CertificateID>
    <TenancyID>1</TenancyID>
    <ContactTaskID>1</ContactTaskID>
    <BatchID>1</BatchID>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:39:57.8281769+00:00</StatusDate>
    <Type>64</Type>
    <AlwaysShowAtTop>64</AlwaysShowAtTop>
    <AddedDate>2025-01-09T20:39:57.8281769+00:00</AddedDate>
    <LegacyAttachments>sample string 4</LegacyAttachments>
    <HighPriority>64</HighPriority>
    <ReadReceiptRequested>64</ReadReceiptRequested>
    <ExternalID>sample string 5</ExternalID>
    <EngagementID>sample string 6</EngagementID>
  </ContactEmailsUpdate>
</ArrayOfContactEmailsUpdate>