POST 17.0/app/correspondence/email/queue

Description

Adds the passed email to the send queue

URI Parameters

None.

EmailQueueRequest
Name Description Type Additional information
ContactId

integer

Required
TemplateId

integer

None.
Subject

string

String length: inclusive between 0 and 255
Body

string

None.
PropertyId

integer

None.
WorkOrderId

integer

None.
PropertyOfferId

integer

None.
CertificateId

integer

None.
TenancyId

integer

None.
AppointmentId

integer

None.
CCs

Collection of integer

None.
BCCs

Collection of integer

None.
SetAsHighPriority

boolean

None.
RequestReadReceipt

boolean

None.

application/json, text/json
Sample: 
{
  "contactId": 1,
  "templateId": 2,
  "subject": "sample string 3",
  "body": "sample string 4",
  "propertyId": 5,
  "workOrderId": 6,
  "propertyOfferId": 7,
  "certificateId": 8,
  "tenancyId": 9,
  "appointmentId": 10,
  "cCs": [
    1,
    2
  ],
  "bcCs": [
    1,
    2
  ],
  "setAsHighPriority": true,
  "requestReadReceipt": true
}

application/xml, text/xml
Sample: 
<EmailQueueRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactId>1</ContactId>
  <TemplateId>2</TemplateId>
  <Subject>sample string 3</Subject>
  <Body>sample string 4</Body>
  <PropertyId>5</PropertyId>
  <WorkOrderId>6</WorkOrderId>
  <PropertyOfferId>7</PropertyOfferId>
  <CertificateId>8</CertificateId>
  <TenancyId>9</TenancyId>
  <AppointmentId>10</AppointmentId>
  <CCs>
    <int>1</int>
    <int>2</int>
  </CCs>
  <BCCs>
    <int>1</int>
    <int>2</int>
  </BCCs>
  <SetAsHighPriority>true</SetAsHighPriority>
  <RequestReadReceipt>true</RequestReadReceipt>
</EmailQueueRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

NewRecord
Name Description Type Additional information
Id

integer

None.

application/json, text/json
Sample: 
{
  "id": 1
}

application/xml, text/xml
Sample: 
<NewRecord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
</NewRecord>