---
title: OnlineFormTypes
description: "OnlineFormTypes: list, get, create, update and delete, plus batch operations."
canonical: https://developers.coevera.com/reference/rest/online-form-types/
section: rest
verification: schema
generatedFrom: spec 5e43371 (2026-10-16)
publisher: Coevera
---

# OnlineFormTypes

OnlineFormTypes: list, get, create, update and delete, plus batch operations.

Family: Online forms. GraphQL: [onlineFormType](https://developers.coevera.com/reference/graphql/online-form-type.md). Base URL: `https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}`.

| Method | Path | Operation |
| --- | --- | --- |
| GET | `/entities/OnlineFormTypes` | List OnlineFormTypes |
| POST | `/entities/OnlineFormTypes` | Create OnlineFormType |
| GET | `/entities/OnlineFormTypes/{id}` | Get OnlineFormType |
| PATCH | `/entities/OnlineFormTypes/{id}` | Update OnlineFormType |
| DELETE | `/entities/OnlineFormTypes/{id}` | Delete OnlineFormType |
| POST | `/entities/OnlineFormTypes/batch-modify` | Create or update OnlineFormTypes in a batch |
| POST | `/entities/OnlineFormTypes/batch-delete` | Delete OnlineFormTypes in a batch |
| POST | `/entities/OnlineFormTypes/batch-restore` | Restore deleted OnlineFormTypes |

## List OnlineFormTypes

`GET /entities/OnlineFormTypes`

Returns the OnlineFormTypes the API application can read, one page at a time. In the list envelope, `total` counts every match and `page_info` pages through them.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `include-deleted` | query | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
| `first` | query | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. (default 30, 1 to 100) |
| `last` | query | integer | Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100. (1 to 100) |
| `before` | query | string | Cursor from `page_info.start_cursor`, to page backwards. URL-encode it. |
| `after` | query | string | Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`. |
| `order-by` | query | string | Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields. |
| `filter` | query | object | `filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space. |
| `filter-op` | query | object | `filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one. |
| `load-only` | query | string | Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118. |

Responses: 200 (Page of OnlineFormType records.: `success`, `total`, `page_info`, `data`), 400, 401, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create OnlineFormType

`POST /entities/OnlineFormTypes`

Creates one record and answers 201 with it.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | 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: The new record's fields. Relations are set by id. Schema `createOnlineFormTypeInput`. Required: `entity_type`, `form_edit`, `is_enabled`, `is_readonly`, `name`, `owner_id`, `style_id`, `custom_recaptcha`.

Responses: 201 (The created OnlineFormType record.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "entity_type": 1,
  "form_edit": {},
  "is_enabled": false,
  "is_readonly": false,
  "name": "Northwind online form type",
  "owner_id": "37000000-0000-4000-a000-000000000001",
  "style_id": "66000000-0000-4000-a000-000000000001",
  "custom_recaptcha": "Northwind custom recaptcha"
}'
```

## Get OnlineFormType

`GET /entities/OnlineFormTypes/{id}`

Returns one record by id. `expand` returns related records inline instead of their URIs.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the OnlineFormType record to retrieve. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts. |

Responses: 200 (The OnlineFormType record.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes/45000000-0000-4000-a000-000000000001?expand=owner' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Update OnlineFormType

`PATCH /entities/OnlineFormTypes/{id}`

Changes the fields you send and leaves the rest as they are; there is no PUT.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the OnlineFormType record to update. |
| `validation-level` | query | integer | 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: The fields to change. Schema `updateOnlineFormTypeInput`.

Responses: 200 (The changed OnlineFormType record.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes/45000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind online form type (renamed)"
}'
```

## Delete OnlineFormType

`DELETE /entities/OnlineFormTypes/{id}`

Deletes one record and answers with its id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the OnlineFormType record to delete. |

Responses: 200 (Deletion confirmation.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes/45000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create or update OnlineFormTypes in a batch

`POST /entities/OnlineFormTypes/batch-modify`

An item with an `id` updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with `rollback-method=1` the response has an id or an error for each item, in input order.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | 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. |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of records: an item with an `id` updates, an item without one creates. Schema `batchOnlineFormTypeInput`. Required: `entity_type`, `form_edit`, `is_enabled`, `is_readonly`, `name`, `owner_id`, `style_id`, `custom_recaptcha`.

Responses: 200 (Result per item, in request order: the id of the created or updated record, or the error.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "entity_type": 1,
    "form_edit": {},
    "is_enabled": false,
    "is_readonly": false,
    "name": "Northwind online form type",
    "owner_id": "37000000-0000-4000-a000-000000000001",
    "style_id": "66000000-0000-4000-a000-000000000001",
    "custom_recaptcha": "Northwind custom recaptcha"
  },
  {
    "id": "45000000-0000-4000-a000-000000000001",
    "name": "Northwind online form type (renamed)"
  }
]'
```

## Delete OnlineFormTypes in a batch

`POST /entities/OnlineFormTypes/batch-delete`

Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the deleted record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "45000000-0000-4000-a000-000000000001",
  "45000000-0000-4000-a000-000000000002"
]'
```

## Restore deleted OnlineFormTypes

`POST /entities/OnlineFormTypes/batch-restore`

Restores the deleted records whose ids are in the body, a JSON array.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the restored record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OnlineFormTypes/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "45000000-0000-4000-a000-000000000001",
  "45000000-0000-4000-a000-000000000002"
]'
```

## OnlineFormType fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | uuid | Read-only. Unique identifier of entity. |
| `entity_type` | integer | Required on create. 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. Values: 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_edit` | object | Required on create. Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. |
| `is_enabled` | boolean | Required on create. When true, the form is published and accepts new submissions; when false, the form returns an error to respondents. |
| `is_readonly` | boolean | Required on create. True when the form is system-managed and its schema cannot be edited by users. |
| `name` | string | Required on create. Name of the entity and its default text representation. |
| `owner_id` | uuid → Clients | Required on create. Id of the owning user. |
| `style_id` | uuid → OnlineFormStyles | Required on create. Id of the form style. |
| `custom_recaptcha` | binary | Required on create. Write-only. 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. |
| `auto_prefill_with_javascript` | boolean | When true, the embedded form JavaScript pre-fills fields from URL query parameters on load. |
| `description` | string | Free-text description shown alongside the form definition in the UI. |
| `entity_api_name` | string | API name of the custom entity the form targets. |
| `last_schema_change` | date-time | Timestamp of the most recent change to form_edit (form schema). |
| `last_status_change` | date-time | Timestamp of the most recent change to is_enabled. |
| `notifications_status` | object | Tracks which threshold-reached notifications have already been sent for the current form configuration. |
| `revision` | integer | Revision when entity was lastly changed. |
| `has_draft` | boolean | Read-only. True when the record has unpublished draft changes, including pending translation changes, that can be published. |
| `is_delete_protected` | boolean | Read-only. True when the record is protected against deletion because it must always exist in the space. |
| `form_edit_api` | object | Read-only. Typed, read-only view of the online form definition (form_edit): its fields, layout and settings. |
| `can_change_readonly` | boolean | Read-only. False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise. |
| `is_deleted` | boolean | Read-only. Specifies if the entity is considered deleted. |
| `modified` | date-time | Read-only. Last modification time. |
| `created` | date-time | Read-only. Creation time. |
| `owner` | uri → Clients | Read-only. User who owns the online form. |
| `style` | uri → OnlineFormStyles | Read-only. Visual style applied to the form when rendered. |
| `activity_logs` | array of uri → OnlineForms | Read-only. Submissions (one per response) recorded for this form. |
| `link_id` | string | Read-only. Short identifier used in the public form URL (see link). |
| `summarized_response_values` | integer | Read-only. Sum of response values used to evaluate the response acceptance threshold (e.g. |
| `link` | string | Read-only. Public URL for accessing the form (suitable for sharing with respondents). |
| `has_custom_recaptcha` | boolean | Read-only. True when the form is configured with custom reCAPTCHA credentials; false when using the platform default reCAPTCHA setup. |

Custom fields appear in your space's live spec: `GET /api/v100/rest/spaces/{space_id}/openapi.json` with your credentials.

## Errors

Every error body has `success: false`, `http_status`, `code`, `name` and `message`. Branch on `code`: the status alone does not tell a missing permission from a bad parameter.

| HTTP | When |
| --- | --- |
| 400 | Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. |
| 401 | Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). |
| 404 | No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). |
| 422 | Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. |
| 429 | Too many requests (code 182). Wait for the seconds in Retry-After, then retry. |
| 500 | Unexpected server error (code 1000, ERROR_UNKNOWN). |

All error codes: https://developers.coevera.com/reference/errors.md; how to handle them: https://developers.coevera.com/concepts/errors.md