LeadProcesses.batch_create_or_update

POST

/entities/LeadProcesses/batch-modify

Create or update an batch of LeadProcesses

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of LeadProcesses on change. 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.

rollback-method

integer <int32>

optional

Specify rollback method for LeadProcesses. 0 - rollback all, 1 - rollback only failed records.

Body Params application / json

array of:

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) {13}]

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

sort_order

integer <int32>

optional

Example:

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.

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",
                "sort_order": 1,
                "timeframe": 1,
                "revision": 1,
                "documents": [
                    {
                        "id": "http://example.com"
                    }
                ],
                "step_checklists": [
                    {
                        "id": "http://example.com"
                    }
                ],
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/LeadProcesses/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "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",
                "sort_order": 1,
                "timeframe": 1,
                "revision": 1,
                "documents": [
                    {
                        "id": "http://example.com"
                    }
                ],
                "step_checklists": [
                    {
                        "id": "http://example.com"
                    }
                ],
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated LeadProcesses

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array [oneOf]

optional

string <uuid>

optional

And ID of created / updated entity.

object (Error)

optional

Example

{
    "success": true,
    "data": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

🔴500Server Error

Modified at 2025-06-26 12:37:59

LeadProcesses.batch_delete

LeadProcesses.batch_restore