PipelinerCRM

Targets.batch_create_or_update

POST

/entities/Targets/batch-modify

Target

Create or update an batch of Targets

Request

Query Params

validation-level

integer <int32>

optional

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

Body Params application / json

array of:

calculation_type

enum<integer>

optional

Integer enum value: 1 - Revenue, 2 - LeadQualified, 3 - LeadCreated

Allowed values:

123

Example:

currency_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

is_active

boolean

optional

Boolean value.

Example:

false

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

period_from

string <date>

optional

Date information.

Example:

2019-01-01

period_to

string <date>

optional

Date information.

Example:

2019-01-01

target_client_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

type

enum<integer>

optional

Integer enum value: 1 - User, 2 - GroupFromUser, 3 - GroupFromExisting

Allowed values:

123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

child_targets

array [object {1}]

optional

Relations to Targets.

string <uri>

optional

string <uuid>

optional

ID of object to update.

Example

[
    {
        "calculation_type": 1,
        "currency_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "is_active": false,
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "period_from": "2019-01-01",
        "period_to": "2019-01-01",
        "target_client_id": "01234567-abcd-dcba-ffff-000000000000",
        "type": 1,
        "revision": 1,
        "child_targets": [
            {
                "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/Targets/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "calculation_type": 1,
        "currency_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "is_active": false,
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "period_from": "2019-01-01",
        "period_to": "2019-01-01",
        "target_client_id": "01234567-abcd-dcba-ffff-000000000000",
        "type": 1,
        "revision": 1,
        "child_targets": [
            {
                "id": "http://example.com"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated Targets

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

Targets.batch_delete

Targets.batch_restore