ImportMappingMasks.batch_create_or_update

POST

/entities/ImportMappingMasks/batch-modify

Create or update an batch of ImportMappingMasks

Request

Query Params

validation-level

integer <int32>

optional

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

Body Params application / json

array of:

entity_api_name

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

entity_type

enum<integer>

optional

Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity

Allowed values:

12345678

Example:

mapping

object

optional

Import mapping mask/relation_types in json format

name

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

relation_types

object

optional

Import mapping mask/relation_types in json format

share_mode

enum<integer>

optional

Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers

Allowed values:

012

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sharing_clients

array [object {1}]

optional

string <uri>

optional

sharing_units

array [object {1}]

optional

string <uri>

optional

string <uuid>

optional

ID of object to update.

Example

[
    {
        "entity_api_name": "string",
        "entity_type": 1,
        "mapping": {},
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "relation_types": {},
        "share_mode": 0,
        "revision": 1,
        "sharing_clients": [
            {
                "id": "http://example.com"
            }
        ],
        "sharing_units": [
            {
                "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/ImportMappingMasks/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "entity_api_name": "string",
        "entity_type": 1,
        "mapping": {},
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "relation_types": {},
        "share_mode": 0,
        "revision": 1,
        "sharing_clients": [
            {
                "id": "http://example.com"
            }
        ],
        "sharing_units": [
            {
                "id": "http://example.com"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated ImportMappingMasks

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

ImportMappingMasks.batch_delete

ImportMappingMasks.batch_restore