SmartSuite icon

SmartSuite

Interact with SmartSuite API

Actions21

API Request → PATCH

AI-generated

Overview

This node performs a PATCH request to the SmartSuite API, allowing users to update resources by specifying a relative URL path, query parameters, headers, and a request body. It is useful for making custom API calls to modify data in SmartSuite when predefined operations do not cover specific needs.

Use Case Examples

  1. Updating a solution or record in SmartSuite by specifying the resource path and sending the updated fields in the request body.
  2. Adding custom headers or query parameters to the PATCH request to meet API requirements.

Properties

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

Output

JSON

  • data - The JSON response data returned from the SmartSuite API after the PATCH request.

Dependencies

  • SmartSuite API
  • 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 their format and correctness to prevent request failures.
  • When using JSON for query parameters, headers, or body, ensure the JSON is valid to avoid parsing errors.
  • Authentication errors may occur if the API key credential is missing or invalid; verify credentials are correctly configured.

Links

Discussion