POST api/processes/updatecontact?contactMatchingMinConfirmedScore={contactMatchingMinConfirmedScore}&contactMatchingMinNameSimilarity={contactMatchingMinNameSimilarity}&contactMatchingEnabled={contactMatchingEnabled}

Update a contact and its associated data if contact details match an existing contact.

Request Information

URI Parameters

Name	Description	Type	Additional information
contactMatchingMinConfirmedScore	The matched contact with the highest score greater or equal than this value will be updated. Otherwise NO update will be performed. Note: if there are multiple matched contacts with the same highest score, then the contact with the highest CrmNumber will be updated.	integer	Default value is 82
contactMatchingMinNameSimilarity	A percentage value to set the minimum similarity of a name search criteria to its potential fuzzy matches. Reducing the similarity percentage will return more names and will also adversely affect performance.	decimal number	Default value is 0.4
contactMatchingEnabled	If set to false, Contact Matching will NOT be done. Therefore if CrmNumber is not provided, NO update will be performed regardless if the key contact fields supplied match an existing contact or not.	boolean	Default value is True

Body Parameters

ContactUpsertDto

Name	Description	Type	Additional information
CrmNumber	A reference to the primary key of the Contact record that it will be updated. If supplied must exist and then that record will be updated. If not supplied, key contact fields will be used to match (if enabled) against a contact. If a suitable match found then that record will be updated. Otherwise, if upsert operation, a new contact will be created.	integer	None.
StudentInstitutionId	The unique identifier for the contact in the institution.	string	None.
Salutation	The name of the Salutation record that is binded to the contact.	string	None.
Name	The given name of the contact.	string	None.
Surname	The family name of the contact.	string	None.
MiddleName	Any additional names that are given to the contact.	string	None.
Alias	Any aliases that the contact may also be known by.	string	None.
FormerName	Any names that the contact previously held.	string	None.
Gender	The gender of the Contact. Valid values are 'M', 'F', 'X' and 'N', which denote Male, Female, Gender Neutral and Not Disclosed respectively.	character	None.
DateOfBirth	The date of birth of the contact. Note that only the date component it's used, the time component will be ignored if specified.	date	None.
EmailAddress	The primary email address that is used to communicate with the contact.	string	None.
EmailAddress2	The alternate email address that is used to communicate with the contact.	string	None.
Mobile		string	None.
PhoneWork		string	None.
PhoneHome		string	None.
FaxWork		string	None.
FaxHome		string	None.
CorrespondenceStreetAddressLine1		string	None.
CorrespondenceStreetAddressLine2		string	None.
CorrespondenceStreetAddressLine3		string	None.
CorrespondenceTownSuburb		string	None.
CorrespondenceStateCity		string	None.
CorrespondencePostcode		string	None.
CorrespondenceCountry		string	None.
CountryOfBirth		string	None.
CountryOfCitizenship		string	None.
DualCountryOfCitizenship		string	None.
CountryOfResidence		string	None.
IsPermanentResident	Whether the student has a permanent resident visa in the country that the institution is in.	boolean	None.
VisaType		string	None.
VisaExpiryDate		date	None.
InclusionStatus		string	None.
HeatStatus		string	None.
HeatStatusReason		string	None.
SubChannel		string	None.
Intake		string	None.
ContactStatus		string	None.
ContactStatusDate		date	None.
ContactStatusReason		string	None.
SubscribedToDirectEmails		boolean	None.
SubscribedToDirectPhoneCalls		boolean	None.
SubscribedToDirectSms		boolean	None.
ContactNoteContent		string	None.
ContactNoteType		string	None.
Inactive	Marks the contact record as inactive (true) or active (false).	boolean	None.
CreateTask	If set to true a task is created in CRM with the provided TaskType, TaskDescription, TaskActionDate.	boolean	None.
TaskType		string	None.
TaskDescription		string	None.
TaskActionDate		date	None.
Tags		Collection of ContactUpsertTagDto	None.
Consents		Collection of ContactUpsertConsentDto	None.
PackageCourses	If true, the collections of courses will all be packaged together under the one single activity. If false, the collections of courses will each be created under their own individual activity. Default: true.	boolean	None.
Courses		Collection of ContactUpsertCourseDto	Max items: 99
Communications		Collection of ContactUpsertCommunicationDto	None.

Request Formats

application/json, text/json

Sample:

{
  "CrmNumber": 1,
  "StudentInstitutionId": "sample string 1",
  "Salutation": "sample string 2",
  "Name": "sample string 3",
  "Surname": "sample string 4",
  "MiddleName": "sample string 5",
  "Alias": "sample string 6",
  "FormerName": "sample string 7",
  "Gender": "A",
  "DateOfBirth": "2024-05-09T05:36:29.2602615+10:00",
  "EmailAddress": "sample string 8",
  "EmailAddress2": "sample string 9",
  "Mobile": "sample string 10",
  "PhoneWork": "sample string 11",
  "PhoneHome": "sample string 12",
  "FaxWork": "sample string 13",
  "FaxHome": "sample string 14",
  "CorrespondenceStreetAddressLine1": "sample string 15",
  "CorrespondenceStreetAddressLine2": "sample string 16",
  "CorrespondenceStreetAddressLine3": "sample string 17",
  "CorrespondenceTownSuburb": "sample string 18",
  "CorrespondenceStateCity": "sample string 19",
  "CorrespondencePostcode": "sample string 20",
  "CorrespondenceCountry": "sample string 21",
  "CountryOfBirth": "sample string 22",
  "CountryOfCitizenship": "sample string 23",
  "DualCountryOfCitizenship": "sample string 24",
  "CountryOfResidence": "sample string 25",
  "IsPermanentResident": true,
  "VisaType": "sample string 26",
  "VisaExpiryDate": "2024-05-09T05:36:29.2602615+10:00",
  "InclusionStatus": "sample string 27",
  "HeatStatus": "sample string 28",
  "HeatStatusReason": "sample string 29",
  "SubChannel": "sample string 30",
  "Intake": "sample string 31",
  "ContactStatus": "sample string 32",
  "ContactStatusDate": "2024-05-09T05:36:29.2602615+10:00",
  "ContactStatusReason": "sample string 33",
  "SubscribedToDirectEmails": true,
  "SubscribedToDirectPhoneCalls": true,
  "SubscribedToDirectSms": true,
  "ContactNoteContent": "sample string 34",
  "ContactNoteType": "sample string 35",
  "Inactive": true,
  "CreateTask": true,
  "TaskType": "sample string 36",
  "TaskDescription": "sample string 37",
  "TaskActionDate": "2024-05-09T05:36:29.2602615+10:00",
  "Tags": [
    {
      "Tag": "sample string 1",
      "TagDate": "2024-05-09T05:36:29.2602615+10:00"
    },
    {
      "Tag": "sample string 1",
      "TagDate": "2024-05-09T05:36:29.2602615+10:00"
    }
  ],
  "Consents": [
    {
      "Type": "sample string 1",
      "Consent": true
    },
    {
      "Type": "sample string 1",
      "Consent": true
    }
  ],
  "PackageCourses": true,
  "Courses": [
    {
      "PreferenceNumber": 1,
      "StudyLevel": "sample string 1",
      "Faculty": "sample string 2",
      "Course": "sample string 3",
      "Department": "sample string 4",
      "Campus": "sample string 5",
      "StudyArea": "sample string 6"
    },
    {
      "PreferenceNumber": 1,
      "StudyLevel": "sample string 1",
      "Faculty": "sample string 2",
      "Course": "sample string 3",
      "Department": "sample string 4",
      "Campus": "sample string 5",
      "StudyArea": "sample string 6"
    }
  ],
  "Communications": [
    {
      "Incoming": true,
      "Category": "sample string 1",
      "Type": "sample string 2",
      "Headline": "sample string 3",
      "Subject": "sample string 4",
      "Code": "sample string 5",
      "Effectiveness": "sample string 6",
      "FromEmailAddress": "sample string 7",
      "ToEmailAddress": "sample string 8",
      "SendExternal": true,
      "Source": "sample string 9",
      "ReferralSource": "sample string 10",
      "DateCreated": "2024-05-09T05:36:29.2602615+10:00"
    },
    {
      "Incoming": true,
      "Category": "sample string 1",
      "Type": "sample string 2",
      "Headline": "sample string 3",
      "Subject": "sample string 4",
      "Code": "sample string 5",
      "Effectiveness": "sample string 6",
      "FromEmailAddress": "sample string 7",
      "ToEmailAddress": "sample string 8",
      "SendExternal": true,
      "Source": "sample string 9",
      "ReferralSource": "sample string 10",
      "DateCreated": "2024-05-09T05:36:29.2602615+10:00"
    }
  ]
}

Response Information

Resource Description

If contact was updated returns a 200 (OK) status code and the Crm Number of the updated contact. If a contact was NOT updated returns 404 (Not Found) status code.

integer

Response Formats

application/json, text/json

Sample: