SmartSuite icon

SmartSuite

Interact with SmartSuite API

API Request → POST

AI-generated

Overview

This node allows users to make custom POST API requests to the SmartSuite REST API at app.smartsuite.com/api/v1. It is useful for scenarios where predefined operations do not cover specific API endpoints or custom interactions are needed. For example, users can create new solutions, records, or trigger actions by specifying the relative URL, query parameters, headers, and request body.

Use Case Examples

  1. Creating a new solution by sending a POST request to /solutions/ with the appropriate JSON body.
  2. Sending a POST request to a custom endpoint with specific query parameters and headers to trigger an action in SmartSuite.

Properties

Name Meaning
URL The relative path to the SmartSuite API endpoint to which the POST request will be sent, relative to app.smartsuite.com/api/v1.
Send Query Parameters Whether to include query parameters in the URL of the POST request.
Specify Query Parameters Method to specify query parameters, either using individual fields or raw JSON.
Query Parameters Individual query parameters as name-value pairs to be included in the URL if 'Using Fields Below' is selected.
Query Parameters (JSON) Raw JSON string representing query parameters if 'Using JSON' is selected.
Send Headers Whether to include HTTP headers in the POST request.
Specify Headers Method to specify headers, either using individual fields or raw JSON.
Header Parameters Individual HTTP headers as name-value pairs to be included if 'Using Fields Below' is selected.
Headers (JSON) Raw JSON string representing headers if 'Using JSON' is selected.
Send Body Whether to include a request body in the POST request.
Specify Body Method to specify the request body, either using individual fields or raw JSON.
Body Parameters Individual body parameters as name-value pairs if 'Using Fields Below' is selected.
Body (JSON) Raw JSON string representing the request body if 'Using JSON' is selected.

Output

JSON

  • statusCode - HTTP status code returned by the API request.
  • headers - HTTP response headers returned by the API request.
  • body - Parsed JSON response body from the API request.

Dependencies

  • SmartSuite API with an API key credential for authentication

Troubleshooting

  • Ensure the URL is correctly specified relative to app.smartsuite.com/api/v1 to avoid 404 errors.
  • If sending query parameters or headers, verify the format and correctness of the fields or JSON to prevent malformed requests.
  • When sending a body, ensure the JSON is valid or the fields are correctly specified to avoid request failures.
  • Authentication errors may occur if the API key credential is missing or invalid; verify credentials are correctly configured.

Links

Discussion