Projects.update - PipelinerCRM

Modifies Project or Projects with given id(s)

Request

Path Params

string <uuid>

required

ID of Project to update

Query Params

validation-level

integer <int32>

optional

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.

Body Params application/json

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

end_date

string <date>

optional

Date information.

Example:

2019-01-01

name

string

optional

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

start_date

string <date>

optional

Date information.

Example:

2019-01-01

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

revenue_goal

object

optional

Monetary value in a foreign currency.

base_value

number <double>

required

Currency.

Example:

4.32

currency_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

value_foreign

number <double>

required

Decimal number.

Example:

4.32

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

sharing_units

array [object {1}]

optional

Relations to SalesUnits.

string <uri>

optional

sharing_clients

array [object {1}]

optional

Relations to Clients.

string <uri>

optional

contact_relations

array [object {1}]

optional

Relations to Contacts.

string <uri>

optional

tags

array [object {1}]

optional

Relations to Tags.

string <uri>

optional

static_profiles

array [object {1}]

optional

Relations to Profiles.

string <uri>

optional

Example

{
  "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",
  "share_mode": 0,
  "start_date": "2019-01-01",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1,
  "revenue_goal": {
    "base_value": "4.32",
    "currency_id": "01234567-abcd-dcba-ffff-000000000000",
    "value_foreign": "4.32"
  },
  "documents": [
    {
      "id": "http://example.com"
    }
  ],
  "sharing_units": [
    {
      "id": "http://example.com"
    }
  ],
  "sharing_clients": [
    {
      "id": "http://example.com"
    }
  ],
  "contact_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "tags": [
    {
      "id": "http://example.com"
    }
  ],
  "static_profiles": [
    {
      "id": "http://example.com"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting Project

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Project)

optional

is_delete_protected

boolean

read-onlyrequired

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.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

account

string <uri>

optional

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>

optional

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

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

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

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>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

end_date

string <date>

required

Date information.

Example:

2019-01-01

name

string

required

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

start_date

string <date>

optional

Date information.

Example:

2019-01-01

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

revenue_goal

object

required

Monetary value in a foreign currency.

documents

array[string <uri>]

optional

Relations to CloudObjects.

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

primary_contact

string <uri>

optional

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

array[string <uri>]

optional

Relations to Contacts.

tags

array[string <uri>]

optional

Relations to Tags.

static_profiles

array[string <uri>]

optional

Relations to Profiles.

objectives

array[string <uri>]

optional

is_favorite

boolean

required

Example:

false

status

enum<integer>

required

Integer enum value: 1 - NotStarted, 2 - InProgress, 4 - Completed

Allowed values:

124

Example:

completion_rate

number <double>

optional

Example:

4.32

activities_total

number <double>

optional

Example:

4.32

activities_completed

number <double>

optional

Example:

4.32

formatted_name

string

required

Example:

string

modified_by_user

string <date-time>

optional

Example:

2019-01-01T00:00:00

Example

{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account": "http://example.com",
    "currency_exchange_rates_list": "http://example.com",
    "owner": "http://example.com",
    "project_type": "http://example.com",
    "unit": "http://example.com",
    "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",
    "share_mode": 0,
    "start_date": "2019-01-01",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "revenue_goal": {
      "base_value": "4.32",
      "currency_id": "01234567-abcd-dcba-ffff-000000000000",
      "value_foreign": "4.32"
    },
    "documents": [
      "http://example.com"
    ],
    "sharing_units": [
      "http://example.com"
    ],
    "sharing_clients": [
      "http://example.com"
    ],
    "primary_contact": "http://example.com",
    "contact_relations": [
      "http://example.com"
    ],
    "tags": [
      "http://example.com"
    ],
    "static_profiles": [
      "http://example.com"
    ],
    "objectives": [
      "http://example.com"
    ],
    "is_favorite": false,
    "status": 1,
    "completion_rate": "4.32",
    "activities_total": "4.32",
    "activities_completed": "4.32",
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}

🟠404Record Not Found

🔴500Server Error