COcoevera
Online Form

OnlineFormTypes.create

Creates a OnlineFormType record.

post/entities/OnlineFormTypes

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

auto_prefill_with_javascriptboolean

When true, the embedded form JavaScript pre-fills fields from URL query parameters on load.

descriptionstring

Free-text description shown alongside the form definition in the UI.

entity_api_namestring

API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty.

entity_type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 required

Entity the form is built for: its fields can be placed on the form and each submission is linked to a record of this entity. For custom entities, entity_api_name identifies the custom entity.

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

form_editobject required

Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write. This payload conforms to the OnlineForm JSON Schema (see the linked schema).

is_enabledboolean required

When true, the form is published and accepts new submissions; when false, the form returns an error to respondents.

is_readonlyboolean required

True when the form is system-managed and its schema cannot be edited by users.

last_schema_changestring date-time

Timestamp of the most recent change to form_edit (form schema).

last_status_changestring date-time

Timestamp of the most recent change to is_enabled.

namestring required

Name of the entity and its default text representation.

notifications_statusobject

Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes.

owner_idstring uuid required

Id of the owning user.

style_idstring uuid required

Id of the form style.

revisioninteger

Revision when entity was lastly changed.

custom_recaptchastring binary required

Custom reCAPTCHA keys (site_key and secret_key) used on the forms of this type instead of the platform default; null switches back to the default. Write-only; has_custom_recaptcha tells whether keys are set.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "description": "string",
  "entity_api_name": "string",
  "entity_type": 1,
  "last_schema_change": "2019-01-01T00:00:00",
  "last_status_change": "2019-01-01T00:00:00",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "style_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1,
  "custom_recaptcha": "blob"
}

Response

The created OnlineFormType record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "description": "string",
    "entity_api_name": "string",
    "entity_type": 1,
    "last_schema_change": "2019-01-01T00:00:00",
    "last_status_change": "2019-01-01T00:00:00",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "style_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "link_id": "string",
    "summarized_response_values": 1,
    "link": "string"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.