SmartSuite icon

SmartSuite

Interact with SmartSuite API

Actions21

API Request → DELETE

AI-generated

Overview

This node performs a DELETE request to the SmartSuite API at a specified URL relative to the base path app.smartsuite.com/api/v1. It allows users to delete resources or data within SmartSuite by specifying the endpoint and optionally including query parameters, headers, and a request body if needed. This is useful for automating the removal of records, solutions, or other entities managed by SmartSuite via its REST API.

Use Case Examples

  1. Deleting a specific record by providing its ID in the URL path.
  2. Removing a solution or configuration by targeting the appropriate API endpoint.

Properties

Name Meaning
URL The API endpoint path relative to app.smartsuite.com/api/v1 where the DELETE request will be sent.
Send Query Parameters Whether to include query parameters in the URL of the DELETE request.
Specify Query Parameters Choose how to specify query parameters, either using individual fields or raw JSON.
Query Parameters Name-value pairs for query parameters to include in the request URL when using fields.
Query Parameters (JSON) Raw JSON string representing query parameters to include in the request URL.
Send Headers Whether to include HTTP headers in the DELETE request.
Specify Headers Choose how to specify headers, either using individual fields or raw JSON.
Header Parameters Name-value pairs for HTTP headers to include in the request when using fields.
Headers (JSON) Raw JSON string representing HTTP headers to include in the request.
Send Body Whether to include a request body in the DELETE request.
Specify Body Choose how to specify the request body, either using individual fields or raw JSON.
Body Parameters Name-value pairs for the request body when using fields.
Body (JSON) Raw JSON string representing the request body payload.

Output

JSON

  • statusCode - HTTP status code returned by the API after the DELETE request.
  • responseBody - The JSON response body returned by the API after the DELETE request.

Dependencies

  • SmartSuite API authentication credential

Troubleshooting

  • Ensure the URL path is correct and relative to app.smartsuite.com/api/v1 to avoid 404 errors.
  • If query parameters or headers are included, verify their correctness and format to prevent request failures.
  • Check API authentication credentials are valid and have permission to perform DELETE operations.
  • If sending a request body, ensure the JSON or fields are properly formatted as per SmartSuite API requirements.

Links

Discussion