OnlineFormTypes.batch_create_or_update

POST

/entities/OnlineFormTypes/batch-modify

Create or update an batch of OnlineFormTypes

Request

Query Params

validation-level

integer <int32>

optional

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

Body Params application / json

array of:

auto_prefill_with_javascript

boolean

optional

Boolean value.

Example:

false

description

string

optional

Multi-line text input field.

Example:

string

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 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product

Allowed values:

123456789101112

Example:

form_edit

object

optional

Form definition in json format.

is_enabled

boolean

optional

Boolean value.

Example:

false

is_readonly

boolean

optional

Boolean value.

Example:

false

last_schema_change

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

last_status_change

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

name

string

optional

Name of the entity and its default text representation.

Example:

string

notifications_status

object

optional

Field containing json.

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

style_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:

custom_recaptcha

string <binary>

optional

Example:

blob

string <uuid>

optional

ID of object to update.

Example

[
    {
        "auto_prefill_with_javascript": false,
        "description": "string",
        "entity_api_name": "string",
        "entity_type": 1,
        "form_edit": {},
        "is_enabled": false,
        "is_readonly": false,
        "last_schema_change": "2019-01-01T00:00:00",
        "last_status_change": "2019-01-01T00:00:00",
        "name": "string",
        "notifications_status": {},
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "style_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "custom_recaptcha": "blob",
        "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/OnlineFormTypes/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "auto_prefill_with_javascript": false,
        "description": "string",
        "entity_api_name": "string",
        "entity_type": 1,
        "form_edit": {},
        "is_enabled": false,
        "is_readonly": false,
        "last_schema_change": "2019-01-01T00:00:00",
        "last_status_change": "2019-01-01T00:00:00",
        "name": "string",
        "notifications_status": {},
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "style_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "custom_recaptcha": "blob",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated OnlineFormTypes

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

OnlineFormTypes.batch_delete

OnlineFormTypes.batch_restore