Sign in
people

Create One person

post/people

Request

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

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

upsertboolean

If true, creates the object or updates it if it already exists.

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": "Anabel",
    "lastName": "Price"
  },
  "emails": {
    "primaryEmail": "felipa.prohaska@yahoo.com",
    "additionalEmails": null
  },
  "linkedinLink": {
    "primaryLinkLabel": "",
    "primaryLinkUrl": "https://utter-atrium.net/",
    "secondaryLinks": []
  },
  "xLink": {
    "primaryLinkLabel": "",
    "primaryLinkUrl": "https://gullible-innovation.info/",
    "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.