StepChecklists.batch_create_or_update

POST

/entities/StepChecklists/batch-modify

Create or update an batch of StepChecklists

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of StepChecklists 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 StepChecklists. 0 - rollback all, 1 - rollback only failed records.

Body Params application / json

array of:

cloud_object_template

object

optional

Relation to CloudObjectTemplate, see: 'updateCloudObjectTemplateInput' object for properties.

string <uri>

optional

activity_type_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_format

enum<integer>

optional

Integer enum value: 0 - Default, 1 - Pdf

Allowed values:

Example:

cloud_object_template_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

email_sequence_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

item_type

enum<integer>

optional

Integer enum value: 1 - Default, 2 - ActivityType, 3 - FieldType, 4 - CreateNote, 5 - AttachDocument, 6 - SendEmail, 7 - UseDocumentTemplate, 8 - EnrollToEmailSequence, 9 - RunProcess, 10 - MapSalesRole, 11 - CreateInfluenceMap

Allowed values:

1234567891011

Example:

item_validation

enum<integer>

optional

Integer enum value: 1 - Required, 2 - RelatedActivityCompleted, 3 - RelatedActivityLinked

Allowed values:

123

Example:

label

string

optional

Multi-line text input field.

Example:

string

label_use_lang

boolean

optional

Boolean value.

Example:

false

process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

send_email_field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

send_email_template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

step_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

visibility_condition

string <binary>

optional

Example:

blob

visibility_type

enum<integer>

optional

Integer enum value: 0 - Always, 1 - Condition

Allowed values:

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sales_roles

array [object {1}]

optional

Relations to SalesRoles.

string <uri>

optional

string <uuid>

optional

ID of object to update.

Example

[
    {
        "cloud_object_template": {
            "id": "http://example.com"
        },
        "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_format": 0,
        "cloud_object_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
        "field_id": "01234567-abcd-dcba-ffff-000000000000",
        "item_type": 1,
        "item_validation": 1,
        "label": "string",
        "label_use_lang": false,
        "process_id": "01234567-abcd-dcba-ffff-000000000000",
        "send_email_field_id": "01234567-abcd-dcba-ffff-000000000000",
        "send_email_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "step_id": "01234567-abcd-dcba-ffff-000000000000",
        "visibility_condition": "blob",
        "visibility_type": 0,
        "revision": 1,
        "sales_roles": [
            {
                "id": "http://example.com"
            }
        ],
        "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/StepChecklists/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "cloud_object_template": {
            "id": "http://example.com"
        },
        "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_format": 0,
        "cloud_object_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
        "field_id": "01234567-abcd-dcba-ffff-000000000000",
        "item_type": 1,
        "item_validation": 1,
        "label": "string",
        "label_use_lang": false,
        "process_id": "01234567-abcd-dcba-ffff-000000000000",
        "send_email_field_id": "01234567-abcd-dcba-ffff-000000000000",
        "send_email_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "step_id": "01234567-abcd-dcba-ffff-000000000000",
        "visibility_condition": "blob",
        "visibility_type": 0,
        "revision": 1,
        "sales_roles": [
            {
                "id": "http://example.com"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated StepChecklists

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

StepChecklists.batch_delete

StepChecklists.batch_restore