Custom Form APIs are used to retrieve, create, and update forms under a case. Custom Form API endpoints are created after a dynamic entity with at least one dynamic field is published. The entity ID is required and is embedded directly in the endpoint URLs, for example:

Before you can see a custom form's endpoints, a system administrator or Case IQ Support must add the custom form to the application. The following endpoints use {entity_id} as a placeholder.

1. Create Custom Form API

POST /dynamic_entity/{entity_id} 

The request payload depends on the dynamic fields defined for the entity. However, caseId is required to create a custom form because all custom forms are created under a case. You can obtain the caseId after creating a case, see the instructions in Case APIs.

2. Retrieve Custom Form API

GET /dynamic_entity/{entity_id}/{form_id} 

To retrieve a custom form, you need the form_id, which is returned when the custom form is created under a case.

3. Update a custom form

PUT (PATCH) /dynamic_entity/{entity_id}/{form_id} 

Similar to retrieval, form_id is required to update a custom form. In addition, caseId is required, the same as when creating a form.