PUT api/people/updatepeople

Update a Person's detailsCommand Processes this people API request. The parameter and response sections describe the data exchanged with the API.
Request Information

URI Parameters

None.
Body Parameters

The people save command data contract supplied with the request.
PeopleSaveCommandDataContract
Name	Description	Type	Additional information
People	The collection of people.	Collection of PersonSaveCommandDataContract	None.
Id	The unique identifier of this resource.	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 'PeopleSaveCommandDataContract'.
application/json, text/json

Sample:
{
  "People": [
    {
      "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        },
        {
          "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        }
      ],
      "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        },
        {
          "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        }
      ],
      "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
    },
    {
      "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        },
        {
          "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        }
      ],
      "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        },
        {
          "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",
          "Country": "sample string 12",
          "Postcode": "sample string 13",
          "Uprn": "sample string 14",
          "CreatedDate": "2026-08-07T19:29:06.3944285Z",
          "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": 16
        }
      ],
      "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
    }
  ],
  "Id": 1
}
Response Information

Resource Description

No Content
PeopleDataContract
Name	Description	Type	Additional information
People	The collection of people.	Collection of PersonDataContract	None.
Id	The unique identifier of this resource.	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 'People[0].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 'People[0].AdditionalInformation.Documents[0].Attachments'.