Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Persons

Update a person

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

patch/v1/persons/{personId}

Path parameters

personIdstring uuid required

Person id

Headers

Customer-Idinteger required

The customer identifier

Request body

titlestring nullable

The person's title<br/><br/>Optional: Omit to retain current value or provide null to unset

forenamestring

The person's first name<br/><br/>Optional: Omit to retain current value

surnamestring

The person's second name<br/><br/>Optional: Omit to retain current value

emailstring

The email address of the person, provide an empty string to unset.<br/><br/>Optional: Omit to retain current value

mobilestring nullable

The mobile telephone number of the person<br/><br/>Optional: Omit to retain current value or provide null to unset

landlinestring nullable

The landline telephone number of the person<br/><br/>Optional: Omit to retain current value or provide null to unset

extensionstring nullable

The landline extension of the person<br/><br/>Optional: Omit to retain current value or provide null to unset

positionstring nullable

The job role that the person holds within the contact<br/><br/>Optional: Omit to retain current value or provide null to unset

departmentstring nullable

The department that the person belongs to<br/><br/>Optional: Omit to retain current value or provide null to unset

isOptedOutboolean

A flag indicating if the contact has opted out of marketing communications<br/><br/>Optional: Omit to retain current value

Example request

{
  "title": "Mr",
  "forename": "David",
  "surname": "Smith",
  "email": "dave.brown@example.com.",
  "mobile": "+447812 123112",
  "landline": "+441312 112441",
  "extension": "12",
  "position": "Manager",
  "department": "Customer service",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content