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. |