POST api/Contacts
Request Information
URI Parameters
None.
Body Parameters
ContactDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| ContactKey | string |
None. |
|
| Forename | string |
None. |
|
| Surname | string |
None. |
|
| AddressLine1 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| AddressLine3 | string |
None. |
|
| AddressLine4 | string |
None. |
|
| Locality | string |
None. |
|
| PostalCode | string |
None. |
|
| CountryCode | string |
None. |
|
| Telephone | string |
None. |
|
| string |
None. |
||
| Visited | boolean |
None. |
|
| VisitedDateTime | date |
None. |
|
| Updated | boolean |
None. |
|
| UpdatedDateTime | date |
None. |
|
| Hostname | string |
None. |
|
| VisitCount | integer |
None. |
|
| ContactProperties | Collection of ContactPropertyDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "443dee66-fa06-4a70-afe7-b19e176e5618",
"ContactKey": "sample string 2",
"Forename": "sample string 3",
"Surname": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"AddressLine4": "sample string 8",
"Locality": "sample string 9",
"PostalCode": "sample string 10",
"CountryCode": "sample string 11",
"Telephone": "sample string 12",
"Email": "sample string 13",
"Visited": true,
"VisitedDateTime": "2026-01-08T03:59:10.0526235+00:00",
"Updated": true,
"UpdatedDateTime": "2026-01-08T03:59:10.0526235+00:00",
"Hostname": "sample string 16",
"VisitCount": 17,
"ContactProperties": [
{
"Id": "9672c37f-e19e-4a86-b3f1-b86fd4634252",
"Value": "sample string 2",
"ContactPropertyTypeId": "26a34e05-b15e-4266-94bc-dcde5750c0c5",
"ContactPropertyType": {
"Id": "0e82535d-e13f-47c5-9217-07df8810c168",
"Name": "sample string 2"
}
},
{
"Id": "9672c37f-e19e-4a86-b3f1-b86fd4634252",
"Value": "sample string 2",
"ContactPropertyTypeId": "26a34e05-b15e-4266-94bc-dcde5750c0c5",
"ContactPropertyType": {
"Id": "0e82535d-e13f-47c5-9217-07df8810c168",
"Name": "sample string 2"
}
}
]
}
application/xml, text/xml
Sample:
<ContactDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.DataCapture.Models">
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<AddressLine4>sample string 8</AddressLine4>
<ContactKey>sample string 2</ContactKey>
<ContactProperties>
<ContactPropertyDto>
<ContactPropertyType>
<Id>0e82535d-e13f-47c5-9217-07df8810c168</Id>
<Name>sample string 2</Name>
</ContactPropertyType>
<ContactPropertyTypeId>26a34e05-b15e-4266-94bc-dcde5750c0c5</ContactPropertyTypeId>
<Id>9672c37f-e19e-4a86-b3f1-b86fd4634252</Id>
<Value>sample string 2</Value>
</ContactPropertyDto>
<ContactPropertyDto>
<ContactPropertyType>
<Id>0e82535d-e13f-47c5-9217-07df8810c168</Id>
<Name>sample string 2</Name>
</ContactPropertyType>
<ContactPropertyTypeId>26a34e05-b15e-4266-94bc-dcde5750c0c5</ContactPropertyTypeId>
<Id>9672c37f-e19e-4a86-b3f1-b86fd4634252</Id>
<Value>sample string 2</Value>
</ContactPropertyDto>
</ContactProperties>
<CountryCode>sample string 11</CountryCode>
<Email>sample string 13</Email>
<Forename>sample string 3</Forename>
<Hostname>sample string 16</Hostname>
<Id>443dee66-fa06-4a70-afe7-b19e176e5618</Id>
<Locality>sample string 9</Locality>
<PostalCode>sample string 10</PostalCode>
<Surname>sample string 4</Surname>
<Telephone>sample string 12</Telephone>
<Updated>true</Updated>
<UpdatedDateTime>2026-01-08T03:59:10.0526235+00:00</UpdatedDateTime>
<VisitCount>17</VisitCount>
<Visited>true</Visited>
<VisitedDateTime>2026-01-08T03:59:10.0526235+00:00</VisitedDateTime>
</ContactDto>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
None.