Skip to main content
PATCH
/
people
/
{personId}
Update person record
curl --request PATCH \
  --url https://api.klipy.ai/api/v1/people/{personId} \
  --header 'Content-Type: application/json' \
  --header 'X-KLIPY-API-KEY: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "linkedin": "in/junghongkim",
  "twitter": "johndoe",
  "facebook": "johndoe",
  "instagram": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "title": "Software Engineer",
  "phone": "+1234567890",
  "personalPhone": "+1987654321",
  "whatsapp": "+1234567890",
  "remarks": "Met at conference"
}
'
{
  "id": "<string>"
}

Authorizations

​
X-KLIPY-API-KEY
string
header
required

Path Parameters

​
personId
string
required

Unique ID of the person record

Body

application/json

Update an existent person record in the team

​
email
string

Email address of the person

Example:

"[email protected]"

​
linkedin
string | null

Linkedin profile URL without the https://www.linkedin.com/ prefix

Example:

"in/junghongkim"

​
twitter
string | null

Twitter handle

Example:

"johndoe"

​
facebook
string | null

Facebook profile URL without the https://www.facebook.com/ prefix

Example:

"johndoe"

​
instagram
string | null

Instagram handle

Example:

"johndoe"

​
firstName
string | null

First name of the person

Example:

"John"

​
lastName
string | null

Last name of the person

Example:

"Doe"

​
title
string | null

Job title

Example:

"Software Engineer"

​
phone
string | null

Primary phone number

Example:

"+1234567890"

​
personalPhone
string | null

Personal phone number

Example:

"+1987654321"

​
whatsapp
string | null

WhatsApp number

Example:

"+1234567890"

​
remarks
string | null

Additional notes or remarks

Example:

"Met at conference"

Response

Success

​
id
string