PipelinerCRM

OpportunityTypes.batch_create_or_update

POST

/entities/OpportunityTypes/batch-modify

Lead & Opportunity

Create or update an batch of OpportunityTypes

Request

Query Params

validation-level

integer <int32>

optional

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

Body Params application / json

array of:

form_edit

object

optional

Form definition in json format.

form_lost

object

optional

Form definition in json format.

form_qualify

object

optional

Form derived definition in json format.

form_won

object

optional

Form derived definition in json format.

is_readonly

boolean

optional

Boolean value.

Example:

false

name

string

optional

Name of the entity and its default text representation.

Example:

string

pipeline_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

settings

string <binary>

optional

Example:

blob

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

string <uuid>

optional

ID of object to update.

Example

[
    {
        "form_edit": {},
        "form_lost": {},
        "form_qualify": {},
        "form_won": {},
        "is_readonly": false,
        "name": "string",
        "pipeline_id": "01234567-abcd-dcba-ffff-000000000000",
        "settings": "blob",
        "revision": 1,
        "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/OpportunityTypes/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "form_edit": {},
        "form_lost": {},
        "form_qualify": {},
        "form_won": {},
        "is_readonly": false,
        "name": "string",
        "pipeline_id": "01234567-abcd-dcba-ffff-000000000000",
        "settings": "blob",
        "revision": 1,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated OpportunityTypes

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

OpportunityTypes.batch_delete

OpportunityTypes.batch_restore