Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Contacts

Update a contact

Update the details of a single contact (required scope contacts:write)

patch/v1/contacts/{contactId}

Path parameters

contactIdinteger required

Contact id

Headers

Customer-Idinteger required

The customer identifier

Request body

referencestring nullable

The internal reference of the contact - should usually be unique<br/><br/>Optional: Omit to retain current value or provide null to unset

namestring

The name of the contact<br/><br/>Optional: Omit to retain current value

groupIdinteger

The unique identifier of the group this contact belongs to<br/><br/>Optional: Omit to retain current value

parentIdinteger nullable

The unique identifier of the parent contact of this contact<br/><br/>Optional: Omit to retain current value or provide null to unset

extraInformationstring nullable

A free text description about the contact<br/><br/>Optional: Omit to retain current value or provide null to unset

streetstring nullable

The contact street address<br/><br/>Optional: Omit to retain current value or provide null to unset

townstring nullable

The contact address town / city / village / locality<br/><br/>Optional: Omit to retain current value or provide null to unset

postalCodestring nullable

The contact address postcode or zipcode<br/><br/>Optional: Omit to retain current value or provide null to unset

countrystring nullable

The textual name of the contact address country<br/><br/>Optional: Omit to retain current value or provide null to unset

Example request

{
  "reference": "5514123",
  "name": "Example Company",
  "groupId": 5514123,
  "parentId": 5514123,
  "extraInformation": "Loyal customer for many years",
  "street": "3150 Century Way",
  "town": "Leeds",
  "postalCode": "LS15 6HU",
  "country": "England",
  "location": {
    "latitude": 51.31349,
    "longitude": -0.7464233
  },
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content