COcoevera
Online Form

OnlineForms.batch_create_or_update

Creates or updates OnlineForm records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/OnlineForms/batch-modify

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.

rollback-method0 | 1

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.

Request body

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to product line items at submission time.

email_idstring uuid

Id of the linked email record, when available.

field_idsobject

Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs).

online_form_type_idstring uuid

Id of the online form definition.

product_currency_idstring uuid

Id of the selected currency.

product_price_list_idstring uuid

Id of the selected price list.

status1 | 2 | 3 | 4 | 5

Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired

revisioninteger

Revision when entity was lastly changed.

idstring uuid

ID of object to update.

Example request

[
  {
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_currency_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "status": 1,
    "revision": 1
  }
]

Response

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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