API Reference

Update Project

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

Updates the project with the given id.

Projects are the primary entity for which people are staffed in Operating. Their client can be either an internal or an external one. A project can have a person as an owner. A project can have Groups related to them, referred in the Operating UI as project groups.

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.

string
length between 1 and 5000

The name of this project

length ≤ 5000

A freeform description of this project. Supports Markdown.

The id of the client for this project. Null if the project has no client.

DEPRECATED Use the /project-group-assignments endpoint instead - The id of the group of this project. Null if the project has no group.

The id of the person who is this project's owner. Null if the project has no owner.

DEPRECATED Use from instead. Estimated start date for this project in YYYY-MM-DD. Null if one doesn't exist.

Estimated start date for this project in YYYY-MM-DD. Null if one doesn't exist.

Estimated end date for this project in YYYY-MM-DD. Null if one doesn't exist.

string

The id of the status of this project.

externalProjects
array of objects

External projects associated with this project. Their external ids must be unique across all projects.

externalProjects

The id of the site this project belongs to.

The id of the person who is this project's secondary owner. Null if the project has no secondary owner.

enum

The billing type for this project. Null if the project has no billing type.

enum

The method of revenue recognition for this project, if the project's billing type is 'fixed-price'. Null will default to 'evenly'.

The project number for this project.

A freeform unique identifier for this project. Must be unique across all projects.

boolean

When true, allows time tracking without requiring a position assignment to this project regardless of permissions.

string

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

enum

The currency of this project as specified by ISO 4217. Used currency must be set up in the Financials settings.

enum

The preferred invoicing currency for new invoices on this project. Null uses the project currency.

Controls whether a note is required on time entries for this project. NULL inherits from Time tracking settings.

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?