--- title: "Projects.update" method: PATCH path: "/entities/Projects/{id}" tags: ["Project"] --- # Projects.update `PATCH /entities/Projects/{id}` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Projects/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Changes fields of the Project record with the given id; fields left out keep their values. ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateProjectInput: Field values to change on a Project record; fields left out keep their values. - `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 that classifies this project. - `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: Value in the base currency of the space. If empty, it is calculated from value_foreign at the current exchange rate. - `currency_id` string, uuid, required: Id of the currency of value_foreign. - `value_foreign` number, double, required: Value in the currency set by currency_id. If empty, it is calculated from base_value at the current exchange rate. - `documents` object[]: Documents linked to this project. - `id` string, uuid: Id of the related CloudObjectRelation record. - `sharing_units` object[]: Sales units that have been granted shared access to this project. Editable only when share_mode allows unit sharing. - `id` string, uuid: Id of the related ProjectSharingSalesUnitRelation record. - `sharing_clients` object[]: Users that have been granted shared access to this project. Editable only when share_mode allows user sharing. - `id` string, uuid: Id of the related ProjectSharingClientRelation record. - `contact_relations` object[]: Contacts linked to this project, including the primary-contact flag. - `id` string, uuid: Id of the related ProjectContactRelation record. - `tags` object[]: Tag labels applied to this project. - `id` string, uuid: Id of the related TagRelation record. - `static_profiles` object[]: Saved view profiles this project currently matches. - `id` string, uuid: Id of the related ProfileRelation record. ## Response `200` The changed Project record. - object - `success` boolean: True when the request succeeded; false on error. - `data` Project: Project delivered for an account or run internally, with its objectives, activities and progress. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `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. Related Account record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Account' for its fields. - `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. Related CurrencyExchangeRatesList record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CurrencyExchangeRatesList' for its fields. - `owner` string, uri, required: Sales user who owns this project. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `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. Related ProjectType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProjectType' for its fields. - `unit` string, uri, required: Sales unit this project is assigned to. Determines which team members can see the record under unit-based sharing. Related SalesUnit record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'SalesUnit' for its fields. - `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 that classifies this project. - `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: Value in the base currency of the space. If empty, it is calculated from value_foreign at the current exchange rate. - `currency_id` string, uuid, required: Id of the currency of value_foreign. - `value_foreign` number, double, required: Value in the currency set by currency_id. If empty, it is calculated from base_value at the current exchange rate. - `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. Related Contact record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Contact' for its fields. - `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 - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). - `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)