PUT api/people/updateperson

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 person save command data contract supplied with the request.

PersonSaveCommandDataContract

Name	Description	Type	Additional information
Gender	The gender value.	EnumDataContract	None.
Title	The title value.	string	None.
FirstName	The first name value.	string	None.
LastName	The last name value.	string	None.
Addresses	The collection of addresses.	Collection of ContactAddressSaveCommandDataContract	None.
ArchivedAddresses	The collection of archived addresses.	Collection of ContactAddressSaveCommandDataContract	None.
ContactItems	The collection of contact items.	Collection of ContactItemSaveCommandDataContract	None.
ServiceTypes	The collection of service types.	Collection of ServiceTypeSaveCommandDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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",
      "Country": "sample string 12",
      "Postcode": "sample string 13",
      "Uprn": "sample string 14",
      "CreatedDate": "2026-08-04T23:20:41.4445756Z",
      "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-04T23:20:41.4445756Z",
      "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-04T23:20:41.4445756Z",
      "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-04T23:20:41.4445756Z",
      "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
}

Response Information

Resource Description

No Content

PersonDataContract

Name	Description	Type	Additional information
Gender	The gender value.	EnumDataContract	None.
Title	The title value.	string	None.
FirstName	The first name value.	string	None.
LastName	The last name value.	string	None.
Note	The note value.	string	None.
ContactName	The contact name value.	string	None.
PrimaryTelephone	The primary telephone value.	ContactItemDataContract	None.
PrimaryEmail	The primary email value.	ContactItemDataContract	None.
GroupCount	The group count value.	integer	None.
GroupMemberships	The collection of group memberships.	Collection of GroupMembershipDataContract	None.
ContactItems	The collection of contact items.	Collection of ContactItemDataContract	None.
Addresses	The collection of addresses.	Collection of ContactAddressDataContract	None.
ArchivedAddresses	The collection of archived addresses.	Collection of ContactAddressDataContract	None.
AdditionalInformation	The additional information value.	AdditionalInformationDataContract	None.
MarketingPreferences	The collection of marketing preferences.	Collection of MarketingPreferenceDataContract	None.
GroupIds	The unique identifiers of the related group resources.	Collection of integer	None.
HasBankAccounts	Indicates whether this item has bank accounts.	boolean	None.
CustomFields	The collection of custom fields.	Collection of CustomFieldGroupWithValuesDataContract	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.