< Back to home

Communication

A communication in SubscriberCRM. A communiation must have either a ContactId or EnquiryId.

Properties

Name Type Description Required
Id Int32 (Nullable) The unique Id of the communication. No
ContactId Int32 (Nullable) The Id of the Contact. No
TypeId Int32 The Id of the communication type. No
CommunicationDate DateTime The date of the communcation. If this is not set, it will automatically get set to the current date/time. No
Email String The email address this communication was sent to if the communication is for an outgoing email. No
Subject String The subject or title of the communication. No
FilePath String The path of the file that is related to this communication. This should be relative and the document would need to be placed in the Document Manager. No
AllocationTypeId CommunicationAllocationType This denotes what the communication is related to, i.e. Fund, Event, Subscription, Other Income or Project. No
AllocationId Int32 The Id of the item which this communication is allocated to. For example, if the AllocationTypeId is Event, the Id of the specific event should be entered here. No
Notes String No
Completed Boolean Has be communication been completed. No
UserId Int32 The Id of the user. No
SubTypeId Int32 The Id of the communication sub type. No
DateAdded DateTime The date the communication was added. If this is not set, it will automatically get set to the current date/time. No
PhoneNumber String The phone number this communication was sent to if the communcation is for an outgoing SMS message. No
Message String The SMS message that was sent. No
DiaryAppointmentDetails DiaryAppointmentDetails The diary appointment details for this Communication. No

Endpoints

Url Actions Description
https://subscribercrmapi.iliberty.org.uk/api/communication POST Adds or updates a communication.

Example

Here is a Json example of the Communication object.

{
  "Id": null,
  "ContactId": 12345,
  "TypeId": -1,
  "CommunicationDate": "2026-06-11T13:45:00.9057393+00:00",
  "Email": "",
  "Subject": "",
  "FilePath": "",
  "AllocationTypeId": -1,
  "AllocationId": -1,
  "Notes": "",
  "Completed": false,
  "UserId": -1,
  "SubTypeId": -1,
  "DateAdded": "2026-06-11T13:45:00.9057393+00:00",
  "PhoneNumber": "",
  "Message": "",
  "DiaryAppointmentDetails": {
    "IncludeInDiary": true,
    "ReminderEnabled": false,
    "ReminderUnits": 0,
    "ReminderTimeInterval": 15,
    "UserId": -1
  }
}