DELETE FormInstances

Description

This API endpoint enables the deletion of generated form instances from the system. It provides clients with the ability to remove specific form instances that are no longer needed or relevant, helping to maintain data integrity and system cleanliness.

ALT

Endpoint

• Endpoint: <environment base url>/v1.0/api/Forms/FormInstances

• Method: DELETE

Request Parameters

Parameter	Type	Required	Multiple values
id	String (max length 32)	Yes	Yes, comma-separated

Response Structure

{
  "data": {
    "formInstances": [
      {
        "id": "String",
        "errorMessage": "String"
      }
    ]
  }
} `

API Contract

id: In case of error along with the error message, max length 32.

Sample Response

{
    "data": {
        "formInstances": [
            {
                "id": "",
                "errorMessage": ""
            }
        ]
    }
}

Sample request [CURL]

curl --location --request DELETE 'https://exampleapi.example.net/v1.0/api/Forms/FormInstances?Id=example-id-1234-5678-90ab-cdef12345678' \
--header 'Authorization: Bearer exampleToken1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz' \
--header 'Cookie: incap_ses_1607_1234567=exampleCookieValue1; incap_ses_76_1234567=exampleCookieValue2; incap_ses_8216_1234567=exampleCookieValue3; nlbi_1234567=exampleCookieValue4; visid_incap_1234567=exampleCookieValue5' \