PipelinerCRM

CloudObjectRelations.batch_create_or_update

POST

/entities/CloudObjectRelations/batch-modify

Document

Create or update an batch of CloudObjectRelations

Request

Query Params

validation-level

integer <int32>

optional

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

Body Params application / json

array of:

cloud_object

object

optional

Relation to CloudObject, see: 'updateCloudObjectInput' object for properties.

id

string <uri>

optional

report_schedule

object

optional

Relation to ReportSchedule, see: 'updateReportScheduleInput' object for properties.

id

string <uri>

optional

text_message

object

optional

Relation to TextMessage, see: 'updateTextMessageInput' object for properties.

id

string <uri>

optional

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

activity_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

approval_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

call_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_folder_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

custom_entity_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_sequence_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

field_mapping_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_oppty_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

media_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

message_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

online_form_field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

online_form_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

process_template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

report_schedule_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

text_message_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

1

id

string <uuid>

optional

ID of object to update.

Example

[
    {
        "cloud_object": {
            "id": "http://example.com"
        },
        "report_schedule": {
            "id": "http://example.com"
        },
        "text_message": {
            "id": "http://example.com"
        },
        "account_id": "01234567-abcd-dcba-ffff-000000000000",
        "activity_id": "01234567-abcd-dcba-ffff-000000000000",
        "approval_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "call_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
        "contact_id": "01234567-abcd-dcba-ffff-000000000000",
        "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "field_mapping_id": "01234567-abcd-dcba-ffff-000000000000",
        "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
        "media_id": "01234567-abcd-dcba-ffff-000000000000",
        "message_id": "01234567-abcd-dcba-ffff-000000000000",
        "online_form_field_id": "01234567-abcd-dcba-ffff-000000000000",
        "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
        "process_id": "01234567-abcd-dcba-ffff-000000000000",
        "process_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "project_id": "01234567-abcd-dcba-ffff-000000000000",
        "quote_id": "01234567-abcd-dcba-ffff-000000000000",
        "report_schedule_id": "01234567-abcd-dcba-ffff-000000000000",
        "text_message_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/entities/CloudObjectRelations/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "cloud_object": {
            "id": "http://example.com"
        },
        "report_schedule": {
            "id": "http://example.com"
        },
        "text_message": {
            "id": "http://example.com"
        },
        "account_id": "01234567-abcd-dcba-ffff-000000000000",
        "activity_id": "01234567-abcd-dcba-ffff-000000000000",
        "approval_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "call_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
        "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
        "contact_id": "01234567-abcd-dcba-ffff-000000000000",
        "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "field_mapping_id": "01234567-abcd-dcba-ffff-000000000000",
        "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
        "media_id": "01234567-abcd-dcba-ffff-000000000000",
        "message_id": "01234567-abcd-dcba-ffff-000000000000",
        "online_form_field_id": "01234567-abcd-dcba-ffff-000000000000",
        "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
        "process_id": "01234567-abcd-dcba-ffff-000000000000",
        "process_template_id": "01234567-abcd-dcba-ffff-000000000000",
        "project_id": "01234567-abcd-dcba-ffff-000000000000",
        "quote_id": "01234567-abcd-dcba-ffff-000000000000",
        "report_schedule_id": "01234567-abcd-dcba-ffff-000000000000",
        "text_message_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated CloudObjectRelations

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

CloudObjectRelations.batch_delete

CloudObjectRelations.batch_restore