POST api/contacts/contactkey

Request Information

URI Parameters

None.

Body Parameters

SaveContactsWithKeyDto
NameDescriptionTypeAdditional information
MaxNameSize

integer

None.

ContactDtos

Collection of ContactDto

None.

Request Formats

application/json, text/json

Sample:
{
  "MaxNameSize": 1,
  "ContactDtos": [
    {
      "Id": "498cac50-5229-4633-9723-1900d5e32cf2",
      "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-07T07:18:30.2594464+00:00",
      "Updated": true,
      "UpdatedDateTime": "2026-01-07T07:18:30.2594464+00:00",
      "Hostname": "sample string 16",
      "VisitCount": 17,
      "ContactProperties": [
        {
          "Id": "a91d51eb-d293-45b2-b26b-8f14c69ca48a",
          "Value": "sample string 2",
          "ContactPropertyTypeId": "d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63",
          "ContactPropertyType": {
            "Id": "7bb34ac9-455a-4b60-90a3-c29b065ecd7e",
            "Name": "sample string 2"
          }
        },
        {
          "Id": "a91d51eb-d293-45b2-b26b-8f14c69ca48a",
          "Value": "sample string 2",
          "ContactPropertyTypeId": "d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63",
          "ContactPropertyType": {
            "Id": "7bb34ac9-455a-4b60-90a3-c29b065ecd7e",
            "Name": "sample string 2"
          }
        }
      ]
    },
    {
      "Id": "498cac50-5229-4633-9723-1900d5e32cf2",
      "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-07T07:18:30.2594464+00:00",
      "Updated": true,
      "UpdatedDateTime": "2026-01-07T07:18:30.2594464+00:00",
      "Hostname": "sample string 16",
      "VisitCount": 17,
      "ContactProperties": [
        {
          "Id": "a91d51eb-d293-45b2-b26b-8f14c69ca48a",
          "Value": "sample string 2",
          "ContactPropertyTypeId": "d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63",
          "ContactPropertyType": {
            "Id": "7bb34ac9-455a-4b60-90a3-c29b065ecd7e",
            "Name": "sample string 2"
          }
        },
        {
          "Id": "a91d51eb-d293-45b2-b26b-8f14c69ca48a",
          "Value": "sample string 2",
          "ContactPropertyTypeId": "d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63",
          "ContactPropertyType": {
            "Id": "7bb34ac9-455a-4b60-90a3-c29b065ecd7e",
            "Name": "sample string 2"
          }
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<SaveContactsWithKeyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.DataCapture.Models">
  <ContactDtos>
    <ContactDto>
      <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>7bb34ac9-455a-4b60-90a3-c29b065ecd7e</Id>
            <Name>sample string 2</Name>
          </ContactPropertyType>
          <ContactPropertyTypeId>d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63</ContactPropertyTypeId>
          <Id>a91d51eb-d293-45b2-b26b-8f14c69ca48a</Id>
          <Value>sample string 2</Value>
        </ContactPropertyDto>
        <ContactPropertyDto>
          <ContactPropertyType>
            <Id>7bb34ac9-455a-4b60-90a3-c29b065ecd7e</Id>
            <Name>sample string 2</Name>
          </ContactPropertyType>
          <ContactPropertyTypeId>d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63</ContactPropertyTypeId>
          <Id>a91d51eb-d293-45b2-b26b-8f14c69ca48a</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>498cac50-5229-4633-9723-1900d5e32cf2</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-07T07:18:30.2594464+00:00</UpdatedDateTime>
      <VisitCount>17</VisitCount>
      <Visited>true</Visited>
      <VisitedDateTime>2026-01-07T07:18:30.2594464+00:00</VisitedDateTime>
    </ContactDto>
    <ContactDto>
      <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>7bb34ac9-455a-4b60-90a3-c29b065ecd7e</Id>
            <Name>sample string 2</Name>
          </ContactPropertyType>
          <ContactPropertyTypeId>d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63</ContactPropertyTypeId>
          <Id>a91d51eb-d293-45b2-b26b-8f14c69ca48a</Id>
          <Value>sample string 2</Value>
        </ContactPropertyDto>
        <ContactPropertyDto>
          <ContactPropertyType>
            <Id>7bb34ac9-455a-4b60-90a3-c29b065ecd7e</Id>
            <Name>sample string 2</Name>
          </ContactPropertyType>
          <ContactPropertyTypeId>d2d23e8d-a66e-407c-ae7f-6adaf4bd6e63</ContactPropertyTypeId>
          <Id>a91d51eb-d293-45b2-b26b-8f14c69ca48a</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>498cac50-5229-4633-9723-1900d5e32cf2</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-07T07:18:30.2594464+00:00</UpdatedDateTime>
      <VisitCount>17</VisitCount>
      <Visited>true</Visited>
      <VisitedDateTime>2026-01-07T07:18:30.2594464+00:00</VisitedDateTime>
    </ContactDto>
  </ContactDtos>
  <MaxNameSize>1</MaxNameSize>
</SaveContactsWithKeyDto>

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

Response Information

Resource Description

None.