Delete Form
Delete a Nintex form that has been saved to a SharePoint list. You must specify the end point and both the list ID and the content type ID.
Note: This API supports forms designed using the Classic Forms and Responsive Forms designers. Forms designed using the New Responsive Forms designer or Nintex Automation Cloud SPFx apps are not supported.
Request
| Method | Request URI | HTTP Version |
|---|---|---|
| DELETE | {baseURL}/api/v1/forms/{listId},{contentTypeId} | HTTP/1.1 |
Request Parameters
| Request Parameter | Description |
|---|---|
| endpointURL | Required. The endpoint URL for the REST API. For more information about the endpoint URL, see "Endpoint URL" above. |
|
listId |
Required. The name or identifier of the SharePoint list or document library. |
|
contentTypeId |
Required. The name or identifier of the SharePoint content type. |
Request Headers
The following table describes required and optional request headers.
| Request Header | Description |
|---|---|
| Content-Type | Required. application/json |
| Authorization | Required. SharePoint form digest value, used to authenticate the request. |
Request Body
None.
Response
The response includes an HTTP status code, response headers, and a response body.
Response Codes
| Code | Description |
|---|---|
| 200 | The specified form was deleted. |
| 400 | An invalid operation has occurred. |
| 401 | An invalid request body was specified. |
| 404 | The specified list could not be found. |
| 500 | Internal error. |
Response Headers
The following table describes response headers returned by a successful response. Other header values may also be returned, depending on SharePoint and ASP.NET configurations.
| Request Header | Description |
|---|---|
| Content-Type | application/xml; charset=utf-8 |
| Content-Type | The length, in characters, of the response body. |
| Cache-Control | private |
Response Body
If the method was successful, a JSON-serialized object is returned that contains the following properties:
| Property | Data type | Description |
|---|---|---|
| { } | string | If the form was successfully deleted, an empty response body is returned. |
Otherwise, depending on the error, the method returns additional information about the error. For example, if the value of the listId property in the request body is set to a name or identifier that cannot be found on the SharePoint site, the response returns an HTTP 400 status code and a Request Error web page in which the error indicates that a list with the specified name does not exist.
Example
The following example demonstrates how to use this operation to delete a Nintex form for a SharePoint list.
Request
The following DELETE request attempts to delete a Nintex form.
https://crestan.nintexo365.com/api/v1/forms/DB0ECEE6-117D-4519-986E-020A9BE6A7E3,0x0100B309C5747F21F94A9FBBAA82DB92F184
Request Body
None.
Response
An HTTP 200 response code is returned, indicating that the form was successfully deleted.
Response Body
The following response body contains the default view URL for the specified SharePoint list.
{}