OnlineFormTypes.update - PipelinerCRM

Modifies OnlineFormType or OnlineFormTypes with given id(s)

Request

Path Params

string <uuid>

required

ID of OnlineFormType to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of OnlineFormType on update. 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.

Body Params application/json

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

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"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting OnlineFormType

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (OnlineFormType)

optional

has_draft

boolean

required

Set to True if draft for entity exists and can be published

Example:

false

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

form_edit_api

object

required

Form definition in json format.

can_change_readonly

boolean

optional

Returns if user can change readonly flag on this entity_type.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

style

string <uri>

required

Relation to OnlineFormStyle. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormStyle' object for properties.

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>

required

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

required

Form definition in json format.

is_enabled

boolean

required

Boolean value.

Example:

false

is_readonly

boolean

required

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

required

Name of the entity and its default text representation.

Example:

string

notifications_status

object

optional

Field containing json.

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

style_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

activity_logs

array[string <uri>]

optional

Relations to OnlineForms.

link_id

string

required

Example:

string

summarized_response_values

integer <int32>

optional

Example:

link

string

optional

Example:

string

has_custom_recaptcha

boolean

required

Example:

false

Example

{
    "success": true,
    "data": {
        "has_draft": false,
        "is_delete_protected": false,
        "form_edit_api": {},
        "can_change_readonly": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "owner": "http://example.com",
        "style": "http://example.com",
        "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,
        "activity_logs": [
            "http://example.com"
        ],
        "link_id": "string",
        "summarized_response_values": 1,
        "link": "string",
        "has_custom_recaptcha": false
    }
}

🟠404Record Not Found

🔴500Server Error