POST api/Contacts/CreateContact
The create contact.
Request Information
URI Parameters
None.
Body Parameters
The contact.
ContactRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| FirstName | string |
None. |
|
| CreatedBy | string |
None. |
|
| Created | date |
None. |
|
| ModifiedBy | string |
None. |
|
| Modified | date |
None. |
|
| IsDeleted | boolean |
None. |
|
| EMFunction | string |
None. |
|
| LastName | string |
None. |
|
| Notes | string |
None. |
|
| Organisation | string |
None. |
|
| PreferredName | string |
None. |
|
| Title | string |
None. |
|
| InternetContacts | Collection of InternetContactRequest |
None. |
|
| Phones | Collection of PhoneRequest |
None. |
|
| AddressRequests | Collection of AddressRequest |
None. |
|
| ContactableByEocIds | Collection of string |
None. |
|
| IsContactActive | boolean |
None. |
|
| IsSystemAdministrator | boolean |
None. |
|
| UserId | string |
None. |
|
| IsUserActive | boolean |
None. |
|
| DefaultRoleName | string |
None. |
|
| AccessLevelAssignmentRequests | Collection of AccessLevelAssignmentRequest |
None. |
|
| PermissionAssignmentRequests | Collection of PermissionAssignmentRequest |
None. |
|
| ContactCategory | string |
None. |
|
| AssociateWithUser | boolean |
None. |
|
| NotificationRequest | NotificationRequest |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "sample string 1",
"FirstName": "sample string 2",
"CreatedBy": "sample string 3",
"Created": "2025-11-22T03:04:27.4146474+00:00",
"ModifiedBy": "sample string 5",
"Modified": "2025-11-22T03:04:27.4302621+00:00",
"IsDeleted": true,
"EMFunction": "sample string 7",
"LastName": "sample string 8",
"Notes": "sample string 9",
"Organisation": "sample string 10",
"PreferredName": "sample string 11",
"Title": "sample string 12",
"InternetContacts": [
{
"Address": "sample string 1",
"TypeKey": "sample string 2"
},
{
"Address": "sample string 1",
"TypeKey": "sample string 2"
}
],
"Phones": [
{
"Number": "sample string 1",
"PhoneTypeKey": "sample string 2"
},
{
"Number": "sample string 1",
"PhoneTypeKey": "sample string 2"
}
],
"AddressRequests": [
{
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"Country": "sample string 3",
"PostCode": "sample string 4",
"State": "sample string 5",
"Suburb": "sample string 6",
"TypeKey": "sample string 7"
},
{
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"Country": "sample string 3",
"PostCode": "sample string 4",
"State": "sample string 5",
"Suburb": "sample string 6",
"TypeKey": "sample string 7"
}
],
"ContactableByEocIds": [
"sample string 1",
"sample string 2"
],
"IsContactActive": true,
"IsSystemAdministrator": true,
"UserId": "sample string 15",
"IsUserActive": true,
"DefaultRoleName": "sample string 17",
"AccessLevelAssignmentRequests": [
{
"Expiry": "2025-11-22T03:04:27.4302621+00:00",
"AccessLevelTypeKey": "sample string 2",
"EocId": "sample string 3"
},
{
"Expiry": "2025-11-22T03:04:27.4302621+00:00",
"AccessLevelTypeKey": "sample string 2",
"EocId": "sample string 3"
}
],
"PermissionAssignmentRequests": [
{
"Expiry": "2025-11-22T03:04:27.4302621+00:00",
"PermissionTypeKey": "sample string 2",
"EocId": "sample string 3"
},
{
"Expiry": "2025-11-22T03:04:27.4302621+00:00",
"PermissionTypeKey": "sample string 2",
"EocId": "sample string 3"
}
],
"ContactCategory": "sample string 18",
"AssociateWithUser": true,
"NotificationRequest": {
"NotificationID": "sample string 1",
"ReferenceID": "sample string 2",
"Subject": "sample string 3",
"Message": "sample string 4",
"CreatedByUserName": "sample string 5",
"Date": "2025-11-22T03:04:27.4458866+00:00",
"ToContacts": [
{
"Id": "sample string 1",
"Noticed": true,
"Read": true,
"Expired": true,
"Name": "sample string 5",
"EmailId": "sample string 6",
"PhoneNumber": "sample string 7"
},
{
"Id": "sample string 1",
"Noticed": true,
"Read": true,
"Expired": true,
"Name": "sample string 5",
"EmailId": "sample string 6",
"PhoneNumber": "sample string 7"
}
],
"ToDistributionList": [
{
"DistributionListId": "sample string 1",
"EocId": "sample string 2",
"EocName": "sample string 3",
"Name": "sample string 4",
"Description": "sample string 5",
"Contacts": [
{
"Id": "sample string 1",
"Name": "sample string 2",
"Email": "sample string 3",
"PhoneNumber": "sample string 4",
"Noticed": true,
"Read": true,
"Expired": true
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"Email": "sample string 3",
"PhoneNumber": "sample string 4",
"Noticed": true,
"Read": true,
"Expired": true
}
],
"Created": "2025-11-22T03:04:27.4615207+00:00"
},
{
"DistributionListId": "sample string 1",
"EocId": "sample string 2",
"EocName": "sample string 3",
"Name": "sample string 4",
"Description": "sample string 5",
"Contacts": [
{
"Id": "sample string 1",
"Name": "sample string 2",
"Email": "sample string 3",
"PhoneNumber": "sample string 4",
"Noticed": true,
"Read": true,
"Expired": true
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"Email": "sample string 3",
"PhoneNumber": "sample string 4",
"Noticed": true,
"Read": true,
"Expired": true
}
],
"Created": "2025-11-22T03:04:27.4615207+00:00"
}
],
"ToEmail": [
"sample string 1",
"sample string 2"
],
"ToSms": [
"sample string 1",
"sample string 2"
],
"TypeOfNotification": null,
"FromContact": "sample string 7",
"TypeOfTriggerEventKey": "sample string 8",
"Documents": null,
"Replies": null,
"NotificationCategoryKey": "sample string 9",
"FirstRef": "sample string 10",
"SecondRef": "sample string 11",
"EMOS": true,
"Email": true,
"SMS": true,
"Priority": "sample string 15"
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The .
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |