| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API. |
integer |
None. |
| CrmNumber |
A reference to the primary key of the Contact record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 2147483647 |
| Subject |
The subject of the communication. |
string |
String length: inclusive between 0 and 1000 |
| Headline |
The headline of the communication. |
string |
String length: inclusive between 0 and 400 |
| Labels |
The labels assigned to this communication |
Collection of CommunicationLabelDto |
None. |
| Incoming |
Indicates if communication is incoming (true) or outgoing (false). |
boolean |
Required |
| CommunicationTypeId |
A reference to the primary key of the CommunicationType record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 99999999 |
| CommunicationTypeName |
The name of the CommunicationType record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| CommunicationCategoryId |
A reference to the primary key of the CommunicationCategory record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 99999999 |
| CommunicationCategoryName |
The name of the CommunicationCategory record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| CommunicationEffectivenessId |
A reference to the primary key of the CommunicationEffectiveness record that is associated with this record. |
integer |
Range: inclusive between 1 and 99999999 |
| CommunicationEffectivenessName |
The name of the CommunicationEffectiveness record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| From |
The communication's From address. |
string |
Required String length: inclusive between 0 and 254 |
| To |
The communication's To address(es). |
string |
Required String length: inclusive between 0 and 4000 |
| Cc |
The communication's CC address(es). |
string |
String length: inclusive between 0 and 4000 |
| Bcc |
The communication's BCC address(es). |
string |
String length: inclusive between 0 and 4000 |
| SubChannelId |
A reference to the primary key of the SubChannel record that is associated with this record. For POST requests sent to the API, the SubChannel record must belong to the parent Channel named 'External'. |
integer |
Required Range: inclusive between 1 and 99999999 |
| SubChannelName |
The name of the SubChannel record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| ChannelId |
A reference to the primary key of the Channel record that is the parent of the SubChannel record. Ignored for POST requests sent to the API. |
integer |
None. |
| ChannelName |
The name of the Channel record that is the parent of the SubChannel record. Ignored for POST requests sent to the API. |
string |
None. |
| Source |
The source of the communication. |
string |
String length: inclusive between 0 and 1000 |
| ReferralSource |
The referral source of the communication. |
string |
String length: inclusive between 0 and 1000 |
| DateCreated |
The date that the communication record was created (in the QSES database). Ignored for POST requests sent to the API. |
date |
None. |