API Reference

Update Person

patch
https://api.operating.app/v1/persons/

Updates the person with the given id.

Persons represent the invidual consultants and staff members of the company who are allocated to projects.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

The instant this record was archived in ISO8601 format in UTC. Null if this record is not archived.

boolean

Controls if the Person to be created is an external resource. False by default.

string
length between 1 and 5000

The name of this person

string
length between 1 and 5000

DEPRECATED: Use name instead. The name of this person. If both supplied, name will be used.

length ≤ 1000

A longer freeform description of this person. Supports Markdown.

length ≤ 150

Short for staffing purposes.

externalPersons
array of objects

External persons associated with this person. Their external ids must be unique across all persons.

externalPersons

The start date of employment in YYYY-MM-DD.

The end date of employment in YYYY-MM-DD.

The id of the person this person reports to.

The id of the site this person belongs to.. Defaults to default site if not set.

length ≤ 5000

The phone number of this person.

length ≤ 5000

The email of this person.

length ≤ 5000

The title of this person.

length ≤ 5000

The employee ID of this person.

string

The id of the company this person belongs to.. Defaults to default company if not provided.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?