PUT api/people/updateperson

Update a Person's detailsCommand

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Gender	EnumDataContract	None.
Title	string	None.
FirstName	string	None.
LastName	string	None.
Addresses	Collection of ContactAddressSaveCommandDataContract	None.
ArchivedAddresses	Collection of ContactAddressSaveCommandDataContract	None.
ContactItems	Collection of ContactItemSaveCommandDataContract	None.
ServiceTypes	Collection of ServiceTypeSaveCommandDataContract	None.
Id	integer	None.

Request Formats

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

application/json, text/json

Sample:

{
  "Gender": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Title": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Addresses": [
    {
      "ContactOrder": 1,
      "AddressType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Latitude": 2.1,
      "Longitude": 3.1,
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 4",
      "OrganizationName": "sample string 5",
      "Number": "sample string 6",
      "BuildingName": "sample string 7",
      "Street": "sample string 8",
      "Town": "sample string 9",
      "Locality": "sample string 10",
      "County": "sample string 11",
      "Postcode": "sample string 12",
      "Uprn": "sample string 13",
      "CreatedDate": "2025-09-15T11:24:34.3070901Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 15
    },
    {
      "ContactOrder": 1,
      "AddressType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Latitude": 2.1,
      "Longitude": 3.1,
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 4",
      "OrganizationName": "sample string 5",
      "Number": "sample string 6",
      "BuildingName": "sample string 7",
      "Street": "sample string 8",
      "Town": "sample string 9",
      "Locality": "sample string 10",
      "County": "sample string 11",
      "Postcode": "sample string 12",
      "Uprn": "sample string 13",
      "CreatedDate": "2025-09-15T11:24:34.3070901Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 15
    }
  ],
  "ArchivedAddresses": [
    {
      "ContactOrder": 1,
      "AddressType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Latitude": 2.1,
      "Longitude": 3.1,
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 4",
      "OrganizationName": "sample string 5",
      "Number": "sample string 6",
      "BuildingName": "sample string 7",
      "Street": "sample string 8",
      "Town": "sample string 9",
      "Locality": "sample string 10",
      "County": "sample string 11",
      "Postcode": "sample string 12",
      "Uprn": "sample string 13",
      "CreatedDate": "2025-09-15T11:24:34.3070901Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 15
    },
    {
      "ContactOrder": 1,
      "AddressType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Latitude": 2.1,
      "Longitude": 3.1,
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 4",
      "OrganizationName": "sample string 5",
      "Number": "sample string 6",
      "BuildingName": "sample string 7",
      "Street": "sample string 8",
      "Town": "sample string 9",
      "Locality": "sample string 10",
      "County": "sample string 11",
      "Postcode": "sample string 12",
      "Uprn": "sample string 13",
      "CreatedDate": "2025-09-15T11:24:34.3070901Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 15
    }
  ],
  "ContactItems": [
    {
      "Id": 1,
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 2",
      "Notes": "sample string 3",
      "ContactOrder": 4,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "NormalisedRegionCode": "sample string 5"
    },
    {
      "Id": 1,
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 2",
      "Notes": "sample string 3",
      "ContactOrder": 4,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "NormalisedRegionCode": "sample string 5"
    }
  ],
  "ServiceTypes": [
    {
      "Service": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Referral": true
    },
    {
      "Service": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Referral": true
    }
  ],
  "Id": 4
}

Response Information

Resource Description

No Content

PersonDataContract

Name	Type	Additional information
Gender	EnumDataContract	None.
Title	string	None.
FirstName	string	None.
LastName	string	None.
Note	string	None.
ContactName	string	None.
PrimaryTelephone	ContactItemDataContract	None.
PrimaryEmail	ContactItemDataContract	None.
GroupCount	integer	None.
GroupMemberships	Collection of GroupMembershipDataContract	None.
ContactItems	Collection of ContactItemDataContract	None.
Addresses	Collection of ContactAddressDataContract	None.
ArchivedAddresses	Collection of ContactAddressDataContract	None.
AdditionalInformation	AdditionalInformationDataContract	None.
MarketingPreferences	Collection of MarketingPreferenceDataContract	None.
GroupIds	Collection of integer	None.
HasBankAccounts	boolean	None.
CustomFields	Collection of CustomFieldGroupWithValuesDataContract	None.
CreatedDate	date	None.
CreatedBy	CreatedByDataContract	None.
Id	integer	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'AdditionalInformation.Documents[0].Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'AdditionalInformation.Documents[0].Attachments'.