people

Update One person

patch/people/{id}

Request

  • Base URL: https://twenty.mardu.systems/rest
  • URL: https://twenty.mardu.systems/rest/people/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Object id.

Query parameters

depth0 | 1

Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations

Request body

jobTitlestring

Contact's job title

citystring

Contact's city

avatarUrlstring

Contact's avatar

positionnumber

Person record Position

companyIdstring uuid
typeCustomstring[]

Example request

{
  "name": {
    "firstName": "Meghan",
    "lastName": "Welch"
  },
  "emails": {
    "primaryEmail": "arlene.pouros53@gmail.com",
    "additionalEmails": null
  },
  "linkedinLink": {
    "primaryLinkLabel": "",
    "primaryLinkUrl": "https://expensive-conservation.biz",
    "secondaryLinks": []
  },
  "xLink": {
    "primaryLinkLabel": "",
    "primaryLinkUrl": "https://second-self-confidence.com/",
    "secondaryLinks": []
  },
  "phones": {
    "primaryPhoneNumber": "06 10 20 30 40",
    "primaryPhoneCallingCode": "+33",
    "primaryPhoneCountryCode": "FR",
    "additionalPhones": []
  },
  "typeCustom": [
    "CUSTOMER"
  ]
}

Response

Successful operation

Changes

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