projects

Update a project

put/projects/{id}

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/projects/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

Project UUID

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

namestring
descriptionstring
status'PLANNING' | 'ACTIVE' | 'ON_HOLD' | 'COMPLETED' | 'CANCELLED'
startDatestring date-time
endDatestring date-time
statusDatestring date nullable

Status date (as-of) for progress reporting; null clears

budgetnumber
progressinteger

Response

Updated project

idstring uuid required
namestring required
status'PLANNING' | 'ACTIVE' | 'ON_HOLD' | 'COMPLETED' | 'CANCELLED' required
progressinteger required
budgetnumber nullable
startDatestring date-time nullable
endDatestring date-time nullable
statusDatestring date nullable

The "as of" date for progress reporting; null means today

autoScheduleboolean

Automatic scheduling. False: editing a date or adding a link moves no other task; only Recalculate writes the dates the scheduler works out. Set with PUT /scheduling/projects/{id}/auto-schedule.

parentDatesFromSubtasksboolean

The default for a task with subtasks: true takes its start and due dates from them, unless the task's own isManual says otherwise. Read only while the server switch parent_date_rollup_enabled is on. Set with PUT /scheduling/projects/{id}/parent-dates.

organizationIdstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.