Skip to content
/
Update Project

Update Project

Request

Updates project-level details.

Security
ApiKey
Path
idstring, (uuid)required

ID of the resource

Body
namestring or null

The name of the Project, typically describing the work engagement or scope for the Client.

statusstring or null(ProjectStatus)

Status for the Project. Default is pre_sale.

Enum:"pre_sale""awaiting_start""completed""in_progress""on_hold"
start_datestring or null, (date)

The scheduled start date for the Project’s resource plan.

end_datestring or null, (date)

The scheduled end date for the Project’s resource plan.

target_marginnumber or null, (double)

Target margin for the Project. Defaults to Organization's target margin.

target_budgetobject or null(Money)

The target budget for the Project, representing the expected revenue from the Client.

archivedboolean or null

Indicates whether the Project is archived and no longer active for delivery or planning.

client_idstring or null, (uuid)

Id of the Client associated with this Project.

stage_idstring or null, (uuid)

Id of the Project's current Pipeline Stage.

project_owner_idstring or null, (uuid)

Id of the Person who owns this Project. Sending null clears the value; omitting leaves it unchanged.

sales_owner_idstring or null, (uuid)

Id of the Person who is responsible for the sale of this Project. Sending null clears the value; omitting leaves it unchanged.

tagsArray of strings or null

A list of tags assigned to the Project for filtering, categorization, or reporting.

project_modelstring or null(ProjectModel)

Project model. Default is client.

Enum:"client""internal"
is_includedboolean or null

Manual flag to hide Projects from reports while keeping them visible in the UI.

curl -i -X PATCH \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{id}' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "status": "pre_sale",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "target_margin": 0.1,
    "target_budget": {
      "currency_code": "string",
      "amount": 0
    },
    "archived": true,
    "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
    "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
    "project_owner_id": "b9aa7b7d-b8d6-4d27-8b60-ee4047e91304",
    "sales_owner_id": "419a49b7-d698-4d74-87b6-314cb4da4e7d",
    "tags": [
      "string"
    ],
    "project_model": "client",
    "is_included": true
  }'

Responses

OK

Response
No content