PUT api/Contacts/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

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

Email

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": "46e130c4-7630-4c02-a151-4578931f433f",
  "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-07T11:53:02.0097005+00:00",
  "Updated": true,
  "UpdatedDateTime": "2026-01-07T11:53:02.0097005+00:00",
  "Hostname": "sample string 16",
  "VisitCount": 17,
  "ContactProperties": [
    {
      "Id": "114b700a-2126-4a0e-9785-dfff34b233a0",
      "Value": "sample string 2",
      "ContactPropertyTypeId": "669e84ff-fe78-422b-b591-db010256f4d1",
      "ContactPropertyType": {
        "Id": "f835c0bc-9761-4d42-bfac-54d714bdb891",
        "Name": "sample string 2"
      }
    },
    {
      "Id": "114b700a-2126-4a0e-9785-dfff34b233a0",
      "Value": "sample string 2",
      "ContactPropertyTypeId": "669e84ff-fe78-422b-b591-db010256f4d1",
      "ContactPropertyType": {
        "Id": "f835c0bc-9761-4d42-bfac-54d714bdb891",
        "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>f835c0bc-9761-4d42-bfac-54d714bdb891</Id>
        <Name>sample string 2</Name>
      </ContactPropertyType>
      <ContactPropertyTypeId>669e84ff-fe78-422b-b591-db010256f4d1</ContactPropertyTypeId>
      <Id>114b700a-2126-4a0e-9785-dfff34b233a0</Id>
      <Value>sample string 2</Value>
    </ContactPropertyDto>
    <ContactPropertyDto>
      <ContactPropertyType>
        <Id>f835c0bc-9761-4d42-bfac-54d714bdb891</Id>
        <Name>sample string 2</Name>
      </ContactPropertyType>
      <ContactPropertyTypeId>669e84ff-fe78-422b-b591-db010256f4d1</ContactPropertyTypeId>
      <Id>114b700a-2126-4a0e-9785-dfff34b233a0</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>46e130c4-7630-4c02-a151-4578931f433f</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-07T11:53:02.0097005+00:00</UpdatedDateTime>
  <VisitCount>17</VisitCount>
  <Visited>true</Visited>
  <VisitedDateTime>2026-01-07T11:53:02.0097005+00:00</VisitedDateTime>
</ContactDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ContactDto'.

Response Information

Resource Description

None.