POST 17.0/app/correspondence/sms/queue

Description

Adds the passed sms text to the send queue

URI Parameters

None.

Name Description Type Additional information
ContactId

integer

Required

TemplateId

integer

Required

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.

application/json, text/json

Sample:
{
  "contactId": 1,
  "templateId": 2,
  "body": "sample string 3",
  "propertyId": 4,
  "workOrderId": 5,
  "propertyOfferId": 6,
  "certificateId": 7,
  "tenancyId": 8,
  "appointmentId": 9,
  "cCs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<SmsQueueRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactId>1</ContactId>
  <TemplateId>2</TemplateId>
  <Body>sample string 3</Body>
  <PropertyId>4</PropertyId>
  <WorkOrderId>5</WorkOrderId>
  <PropertyOfferId>6</PropertyOfferId>
  <CertificateId>7</CertificateId>
  <TenancyId>8</TenancyId>
  <AppointmentId>9</AppointmentId>
  <CCs>
    <int>1</int>
    <int>2</int>
  </CCs>
</SmsQueueRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

None.

None.