---
title: "Projects.update"
method: PATCH
path: "/entities/Projects/{id}"
tags: ["Project"]
---

# Projects.update

`PATCH /entities/Projects/{id}`

Modifies Project or Projects with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateProjectInput
  - `account_id` string, uuid — Id of the related account.
  - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list applied to this project.
  - `description` string — Free-form description of the project.
  - `end_date` string, date — Planned end date of the project. Must be on or after start_date when both are set.
  - `name` string — Name of the entity and its default text representation.
  - `owner_id` string, uuid — Id of the project owner.
  - `project_type_id` string, uuid — Id of the project type.
  - `share_mode` 0 | 1 | 2 | 3 — Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
  - `start_date` string, date — Date when the project starts.
  - `unit_id` string, uuid — Id of the sales unit.
  - `revision` integer — Revision when entity was lastly changed.
  - `revenue_goal` object — Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside.
    - `base_value` number, double, required — Currency.
    - `currency_id` string, uuid, required — Relation to single entity instance.
    - `value_foreign` number, double, required — Decimal number.
  - `documents` object[] — Documents linked to this project.
    - `id` string, uri
  - `sharing_units` object[] — Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing.
    - `id` string, uri
  - `sharing_clients` object[] — Users that have been granted shared access to this project. Editable only when share_mode allows user sharing.
    - `id` string, uri
  - `contact_relations` object[] — Contacts linked to this project, including the primary-contact flag.
    - `id` string, uri
  - `tags` object[] — Tag labels applied to this project.
    - `id` string, uri
  - `static_profiles` object[] — Saved view profiles this project currently matches.
    - `id` string, uri

## Response `200`

Modification confirmation. Returns resulting Project

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Project
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `account` string, uri — Account this project is delivered for, or empty for internal projects without an external account. Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.
    - `currency_exchange_rates_list` string, uri — Currency exchange rate list used to convert monetary fields linked to this project. Empty to inherit the team space default. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.
    - `owner` string, uri, required — Sales user who owns this project. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `project_type` string, uri, required — Project type that classifies this project. Project types are configurable per team space and drive which form, fields and objectives apply. Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties.
    - `unit` string, uri, required — Sales unit this project is assigned to. Determines which team members can see the record under unit-based sharing. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.
    - `account_id` string, uuid — Id of the related account.
    - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list applied to this project.
    - `description` string — Free-form description of the project.
    - `end_date` string, date, required — Planned end date of the project. Must be on or after start_date when both are set.
    - `name` string, required — Name of the entity and its default text representation.
    - `owner_id` string, uuid, required — Id of the project owner.
    - `project_type_id` string, uuid — Id of the project type.
    - `share_mode` 0 | 1 | 2 | 3 — Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
    - `start_date` string, date — Date when the project starts.
    - `unit_id` string, uuid — Id of the sales unit.
    - `revision` integer — Revision when entity was lastly changed.
    - `revenue_goal` object, required — Target revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside.
      - `base_value` number, double, required — Currency.
      - `currency_id` string, uuid, required — Relation to single entity instance.
      - `value_foreign` number, double, required — Decimal number.
    - `documents` string[] — Documents linked to this project.
    - `sharing_units` string[] — Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing.
    - `sharing_clients` string[] — Users that have been granted shared access to this project. Editable only when share_mode allows user sharing.
    - `primary_contact` string, uri — Primary contact of this project. Set automatically from the contact relation marked as primary. Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.
    - `contact_relations` string[] — Contacts linked to this project, including the primary-contact flag.
    - `tags` string[] — Tag labels applied to this project.
    - `static_profiles` string[] — Saved view profiles this project currently matches.
    - `objectives` string[] — Objectives defined for this project, sorted by display order.
    - `is_favorite` boolean, required — True when the current authenticated user has marked this project as favorite. Per-user.
    - `status` 1 | 2 | 4, required — Current status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress. Integer enum value: 1 - NotStarted, 2 - InProgress, 4 - Completed
    - `completion_rate` number, double — Percentage of activities (tasks and appointments) on this project that are completed. Read-only; computed by Coevera.
    - `activities_total` number, double — Total number of activities (tasks and appointments) linked to this project. Read-only; computed by Coevera.
    - `activities_completed` number, double — Number of completed activities on this project. Read-only; computed by Coevera.
    - `formatted_name` string, required — Display version of the project name, used in lists and references.
    - `modified_by_user` string, date-time — Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)