PipelinerCRM

Clients.batch_create_or_update

POST

/entities/Clients/batch-modify

Client

Create or update an batch of Clients

Request

Query Params

validation-level

integer <int32>

optional

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

Body Params application / json

array of:

default_unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

master_right_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

position

string

optional

Simple text input field.

Example:

string

type

enum<integer>

optional

Integer enum value: 0 - Customer, 1 - Support

Allowed values:

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

unit_membership

array [object {1}]

optional

Relations to SalesUnits.

string <uri>

optional

appointment_favorite

array [object {1}]

optional

Relations to Appointments.

string <uri>

optional

task_favorite

array [object {1}]

optional

Relations to Tasks.

string <uri>

optional

account_favorite

array [object {1}]

optional

Relations to Accounts.

string <uri>

optional

contact_favorite

array [object {1}]

optional

Relations to Contacts.

string <uri>

optional

profile_favorite

array [object {1}]

optional

Relations to Profiles.

string <uri>

optional

report_favorite

array [object {1}]

optional

Relations to Reports.

string <uri>

optional

lead_favorite

array [object {1}]

optional

Relations to Leads.

string <uri>

optional

opportunity_favorite

array [object {1}]

optional

Relations to Opportunitys.

string <uri>

optional

string <uuid>

optional

ID of object to update.

Example

[
    {
        "default_unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "master_right_id": "01234567-abcd-dcba-ffff-000000000000",
        "position": "string",
        "type": 0,
        "revision": 1,
        "unit_membership": [
            {
                "id": "http://example.com"
            }
        ],
        "appointment_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "task_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "account_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "contact_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "profile_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "report_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "lead_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "opportunity_favorite": [
            {
                "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/Clients/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "default_unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "master_right_id": "01234567-abcd-dcba-ffff-000000000000",
        "position": "string",
        "type": 0,
        "revision": 1,
        "unit_membership": [
            {
                "id": "http://example.com"
            }
        ],
        "appointment_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "task_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "account_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "contact_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "profile_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "report_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "lead_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "opportunity_favorite": [
            {
                "id": "http://example.com"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated Clients

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

Clients.batch_delete

Clients.batch_restore