Contacts

Update Person by Contact Id

See glossary for definition of <a href="https://developers.zoopla.co.uk/docs/glossary#person">Person</a>.

patch/contacts/{contactId}/persons/{personId}

Request

Base URL: https://api.alto.zoopladev.co.uk
URL: https://api.alto.zoopladev.co.uk/contacts/{contactId}/persons/{personId}
Auth: appAuth (a scheme the document does not define)

Path parameters

contactIdstring required

The unique identifier for the Contact.

personIdstring required

The Person identifier within the Contact.

Headers

AgencyRefstring required

Request body

Example request

[
  {
    "value": "\"Ms\"",
    "path": "/Title"
  }
]

Response

Returns the updated Person.

idstring nullable

The unique identifier for the resource.

titlestring nullable

The formal title of the Person.

forenamestring nullable

The first or given name of the Person.

surnamestring nullable

The surname of the Person.

Example response

{
  "title": "Ms",
  "forename": "Jane",
  "surname": "Doe",
  "phoneNumbers": [
    {
      "preferenceOrder": 1,
      "type": "Mobile",
      "number": "01234567891",
      "description": "John's mobile"
    }
  ],
  "emailAddresses": [
    {
      "preferenceOrder": 2,
      "type": "Business",
      "address": "john.doe@business.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.