Skip to content

Update person

PATCH
/api/people/{id}
 
curl --request PATCH \
  --url http://localhost:3000/api/people/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{}'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json

Any subset of the person create body

object
Example generated
{}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Person updated

Media type application/json
object
data
object
id
required
string format: uuid
fullName
required
string
email
string
nullable
phone
string
nullable
jobTitle
string
nullable
department
string
nullable
employeeId
string
nullable
siteId
string format: uuid
nullable
siteName
string
nullable
profileId
string format: uuid
nullable
status
required
string
default: active
startDate
string format: date
nullable
notes
string
nullable
profile
object
id
string format: uuid
email
string
role
string
isActive
boolean
assetCount

Open assignments (list endpoint)

integer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example 
{
  "data": {
    "status": "active"
  }
}

400

Section titled “400 ”

No fields to update

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

404

Section titled “404 ”

Person not found

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

409

Section titled “409 ”

Email or profile already linked to another person

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}