Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Online

OnlineForms.update

Modifies OnlineForm or OnlineForms with given id(s)

patch/entities/OnlineForms/{id}

Path parameters

idstring uuid required

ID of OnlineForm to update

Query parameters

validation-levelinteger

Specify validation level of OnlineForm 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.

Request body

currency_exchange_rates_list_idstring uuid

Id of the exchange rate list.

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

Field whose values are strictly defined with an enumeration of values.

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

revisioninteger

Revision when entity was lastly changed.

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

Modification confirmation. Returns resulting OnlineForm

successboolean

True when response 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",
    "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,
    "responded_by": "string",
    "response_date": "2019-01-01T00:00:00"
  }
}