LeadProcesses.update - PipelinerCRM

Modifies LeadProcess or LeadProcesses with given id(s)

Request

Path Params

string <uuid>

required

ID of LeadProcess to update

Query Params

validation-level

integer <int32>

optional

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

color

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

name

string

optional

Name of the entity and its default text representation.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

steps

array[object (batchStepInput) {12}]

optional

description

string

optional

Multi-line text input field.

Example:

string

has_readonly_form

boolean

optional

Boolean value.

Example:

false

has_version_increment

boolean

optional

Boolean value.

Example:

false

lead_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

name

string

optional

Name of the entity and its default text representation.

Example:

string

percent

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

quote_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

timeframe

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

documents

array [object {1}]

optional

Relations to CloudObjects.

step_checklists

array [object {1}]

optional

Relations to StepChecklists.

string <uuid>

optional

ID of object to update.

Example

{
  "color": 1,
  "name": "string",
  "revision": 1,
  "steps": [
    {
      "description": "string",
      "has_readonly_form": false,
      "has_version_increment": false,
      "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
      "name": "string",
      "percent": 1,
      "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
      "timeframe": 1,
      "revision": 1,
      "documents": [
        {
          "id": "http://example.com"
        }
      ],
      "step_checklists": [
        {
          "id": "http://example.com"
        }
      ],
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting LeadProcess

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (LeadProcess)

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

color

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

name

string

required

Name of the entity and its default text representation.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

steps

array[object (batchStepInput) {12}]

required

lead_types

array[string <uri>]

required

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",
    "color": 1,
    "name": "string",
    "revision": 1,
    "steps": [
      {
        "description": "string",
        "has_readonly_form": false,
        "has_version_increment": false,
        "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "percent": 1,
        "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "timeframe": 1,
        "revision": 1,
        "documents": [
          {
            "id": "http://example.com"
          }
        ],
        "step_checklists": [
          {
            "id": "http://example.com"
          }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "lead_types": [
      "http://example.com"
    ]
  }
}

🟠404Record Not Found

🔴500Server Error