--- title: "OnlineForms.update" method: PATCH path: "/entities/OnlineForms/{id}" tags: ["Online Form"] --- # OnlineForms.update `PATCH /entities/OnlineForms/{id}` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/OnlineForms/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Changes fields of the OnlineForm record with the given id; fields left out keep their values. ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateOnlineFormInput: Field values to change on an OnlineForm record; fields left out keep their values. - `currency_exchange_rates_list_id` string, uuid: Id of the currency exchange rate list applied to product line items at submission time. - `email_id` string, uuid: Id of the linked email record, when available. - `field_ids` object: Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). - `online_form_type_id` string, uuid: Id of the online form definition. - `product_currency_id` string, uuid: Id of the selected currency. - `product_price_list_id` string, uuid: Id of the selected price list. - `status` 1 | 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 - `revision` integer: Revision when entity was lastly changed. - `account_relations` object[]: Accounts the submission was linked to. - `id` string, uuid: Id of the related OnlineFormRelation record. - `contact_relations` object[]: Contacts the submission was linked to. - `id` string, uuid: Id of the related OnlineFormRelation record. - `lead_relations` object[]: Leads the submission was linked to. - `id` string, uuid: Id of the related OnlineFormRelation record. - `opportunity_relations` object[]: Opportunities the submission was linked to. - `id` string, uuid: Id of the related OnlineFormRelation record. - `quote_relations` object[]: Quotes the submission was linked to. - `id` string, uuid: Id of the related OnlineFormRelation record. - `project_relations` object[]: Projects the submission was linked to. - `id` string, uuid: Id of the related OnlineFormRelation record. - `custom_entity_relations` object[]: Custom entity records the submission was linked to. - `id` string, uuid: Id of the related OnlineFormRelation record. ## Response `200` The changed OnlineForm record. - object - `success` boolean: True when the request succeeded; false on error. - `data` OnlineForm: Submission (response) of an online form, with the answers and the records it created or updated. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `currency_exchange_rates_list` string, uri: Currency exchange rate list applied to product line-items at submission time. Related CurrencyExchangeRatesList record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CurrencyExchangeRatesList' for its fields. - `email` string, uri: Email submitted with the response, used for identification or response notifications. Related Email record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Email' for its fields. - `online_form_type` string, uri, required: Online form definition this submission belongs to. Related OnlineFormType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OnlineFormType' for its fields. - `product_currency` string, uri, required: Currency selected by the respondent for product line-items, when the form contains products. Related Currency record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Currency' for its fields. - `product_price_list` string, uri: Product price list selected by the respondent, when the form contains products. Related ProductPriceList record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProductPriceList' for its fields. - `currency_exchange_rates_list_id` string, uuid: Id of the currency exchange rate list applied to product line items at submission time. - `email_id` string, uuid: Id of the linked email record, when available. - `field_ids` object, required: Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs). - `online_form_type_id` string, uuid, required: Id of the online form definition. - `product_currency_id` string, uuid: Id of the selected currency. - `product_price_list_id` string, uuid: Id of the selected price list. - `status` 1 | 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 - `revision` integer: Revision when entity was lastly changed. - `account_relations` string[]: Accounts the submission was linked to. - `contact_relations` string[]: Contacts the submission was linked to. - `lead_relations` string[]: Leads the submission was linked to. - `opportunity_relations` string[]: Opportunities the submission was linked to. - `quote_relations` string[]: Quotes the submission was linked to. - `project_relations` string[]: Projects the submission was linked to. - `custom_entity_relations` string[]: Custom entity records the submission was linked to. - `lines` string[]: Activity log lines describing what was done with this submission (visible only). - `responded_by` string, required: Display name of the primary record (account/contact/lead/...) the submission was linked to. - `response_date` string, date-time: Timestamp the submission was received (the response was completed). ## Other responses - `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). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)