Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Project

Projects.update

Modifies Project or Projects with given id(s)

patch/entities/Projects/{id}

Path parameters

idstring uuid required

ID of Project to update

Query parameters

validation-levelinteger

Specify validation level of Project on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

account_idstring uuid

Id of the related account.

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this project.

descriptionstring

Free-form description of the project.

end_datestring date

Planned end date of the project. Must be on or after start_date when both are set.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the project owner.

project_type_idstring uuid

Id of the project type.

share_mode0 | 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_datestring date

Date when the project starts.

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "description": "string",
  "end_date": "2019-01-01",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "start_date": "2019-01-01",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1,
  "revenue_goal": {
    "currency_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}

Response

Modification confirmation. Returns resulting Project

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "end_date": "2019-01-01",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "start_date": "2019-01-01",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "revenue_goal": {
      "currency_id": "01234567-abcd-dcba-ffff-000000000000"
    },
    "status": 1,
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}