Skip to main content
PATCH
/
partner
/
commenda-os
/
companies
/
{companyId}
/
persons
/
{personId}
Update a person
curl --request PATCH \
  --url https://api.prod.commenda.io/api/v1/partner/commenda-os/companies/{companyId}/persons/{personId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "Jane",
  "lastName": "Founder",
  "email": "jane@acme.com",
  "dateOfBirth": "1990-04-18",
  "countryOfCitizenship": "SG"
}
'
{
  "id": 12
}
Partially update a reusable Commenda OS key person for a partner-accessible company. This endpoint uses the same person-update semantics as the internal Commenda OS API: omitted fields are left unchanged, and the response returns the updated person identifier. Use incorporation participant and document endpoints for incorporation-specific roles and documents.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
companyId
integer
required

Commenda company identifier accessible to the authenticated partner.

​
personId
integer
required

Commenda OS person identifier for the specified company.

Body

application/json

Partial update payload for a reusable Commenda OS key person. Omitted fields are left unchanged.

​
firstName
string
Example:

"Jane"

​
lastName
string
Example:

"Founder"

​
email
string<email>
Example:

"jane@acme.com"

​
phoneNumber
string
Example:

"+14155550123"

​
locations
object[]

Person addresses using the same shape as the internal Commenda OS person update API.

​
employmentStartDate
string<date>
Example:

"2025-01-01"

​
dateOfBirth
string<date>
Example:

"1990-04-18"

​
countryOfCitizenship
string
Example:

"SG"

​
ssn
string

SSN or ITIN, when applicable.

Example:

"123-45-6789"

​
hasNoSSN
boolean
Example:

false

​
directorIdentificationNumber
string

Director Identification Number (DIN) assigned to Indian directors.

Example:

"00012345"

Response

Person updated successfully

​
id
integer
required

Updated Commenda OS person identifier.

Example:

12