< Back to home

Contact

Information about a contact in SubscriberCRM.

Properties

Name Type Description Required
ContactId Int32 No
Title String No
FirstName String No
Surname String No
Position String The contacts position. No
Department String The contacts department. No
Organisation String The contacts organisation. No
Address_Position String The position on the contacts address. No
Address_Department String The department on the contacts address. No
Address_Organisation String The organisation on the contacts address. No
Address_AddressLine1 String No
Address_AddressLine2 String No
Address_AddressLine3 String No
Address_Town String No
Address_County String The name of the county list item. No
Address_CountyId Int32 The id of the county list item. No
Address_Postcode String No
Address_Country String The name of the country list item. No
Address_CountryId Int32 The id of the country list item. No
Address_Telephone String No
Address_EveningTelephone String No
Address_Mobile String No
Address_Email String No
Gender String The name of the gender list item. No
GenderId Int32 The id of the gender list item. No
Ethnicity String The name of the ethincity list item. No
EthnicityId Int32 The id of the ethincity list item. No
Age Int32 (Nullable) No
Profile_PersonalDetails_TotalPaymentAmount String The total amount of all payments this contact has made. This is in a coded format. No
Profile_PersonalDetails_LastPaymentAmount String The amount of the last payments this contact has made. This is in a coded format. No
Profile_PersonalDetails_LastPaymentDate DateTime (Nullable) The date of the last payment has made. No
Profile_Summaries_PD_Count Int32 (Nullable) No
Profile_Summaries_LastVisit_Date DateTime (Nullable) No
Profile_Summaries_LastVisit_Visitor String No
Profile_Summaries_LastVisit_Amount String The amount raised from the last contact campaign appointment (visit). This is in a coded format. No
Profile_Summaries_Visit_Count Int32 (Nullable) No
Profile_Summaries_LastSV_Date DateTime (Nullable) No
Profile_Summaries_SV_Count Int32 (Nullable) No
Profile_Summaries_LastEventDate DateTime (Nullable) No

Endpoints

Url Actions Description
https://subscribercrmapi.iliberty.org.uk/api/contact/{contactId:int}/ GET Get an individual contact from the ContactId.
https://subscribercrmapi.iliberty.org.uk/api/contact/?contactCampaignId={contactCampaignId:int}&userId={userId:int}&userList={userList:string} GET Gets a list of contacts who meet the specified criteria. Not all the paramters have to be entered, although if the userList is entered the contactCampaignId and userId must also be entered.

Example

Here is a Json example of the Contact object.

{
  "ContactId": 12345,
  "Title": "Mr",
  "FirstName": "John",
  "Surname": "Smith",
  "Position": null,
  "Department": null,
  "Organisation": null,
  "Address_Position": null,
  "Address_Department": null,
  "Address_Organisation": null,
  "Address_AddressLine1": null,
  "Address_AddressLine2": null,
  "Address_AddressLine3": null,
  "Address_Town": null,
  "Address_County": null,
  "Address_CountyId": 0,
  "Address_Postcode": null,
  "Address_Country": null,
  "Address_CountryId": 0,
  "Address_Telephone": null,
  "Address_EveningTelephone": null,
  "Address_Mobile": null,
  "Address_Email": null,
  "Gender": null,
  "GenderId": 0,
  "Ethnicity": null,
  "EthnicityId": 0,
  "Age": null,
  "Profile_PersonalDetails_TotalPaymentAmount": null,
  "Profile_PersonalDetails_LastPaymentAmount": null,
  "Profile_PersonalDetails_LastPaymentDate": null,
  "Profile_Summaries_PD_Count": null,
  "Profile_Summaries_LastVisit_Date": null,
  "Profile_Summaries_LastVisit_Visitor": null,
  "Profile_Summaries_LastVisit_Amount": null,
  "Profile_Summaries_Visit_Count": null,
  "Profile_Summaries_LastSV_Date": null,
  "Profile_Summaries_SV_Count": null,
  "Profile_Summaries_LastEventDate": null
}