Processes.update - PipelinerCRM

Modifies Process or Processes with given id(s)

Request

Path Params

string <uuid>

required

ID of Process to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of Process 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

description

string

optional

Multi-line text input field.

Example:

string

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

settings

object

optional

Form definition in json format.

type

enum<integer>

optional

Integer enum value: 1 - Personal, 2 - Space

Allowed values:

Example:

tags

array [object {1}]

optional

Relations to Tags.

string <uri>

optional

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

Example

{
    "description": "string",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": {},
    "type": 1,
    "tags": [
        {
            "id": "http://example.com"
        }
    ],
    "documents": [
        {
            "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 Process

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Process)

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

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.

deactivation_reason

enum<integer>

optional

Integer enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 - DisabledFeature

Allowed values:

0123

Example:

description

string

optional

Multi-line text input field.

Example:

string

is_enabled

boolean

optional

Boolean value.

Example:

false

last_schema_change

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

last_status_change

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

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

settings

object

optional

Form definition in json format.

type

enum<integer>

required

Integer enum value: 1 - Personal, 2 - Space

Allowed values:

Example:

activity_logs

array[string <uri>]

optional

Relations to ProcessActivityLogs.

tags

array[string <uri>]

optional

Relations to Tags.

activity

object

required

documents

array[string <uri>]

optional

Relations to CloudObjects.

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",
        "owner": "http://example.com",
        "deactivation_reason": 0,
        "description": "string",
        "is_enabled": false,
        "last_schema_change": "2019-01-01T00:00:00",
        "last_status_change": "2019-01-01T00:00:00",
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "settings": {},
        "type": 1,
        "activity_logs": [
            "http://example.com"
        ],
        "tags": [
            "http://example.com"
        ],
        "activity": {},
        "documents": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error