SmartSuite icon

SmartSuite

Interact with SmartSuite API

Actions21

API Request → PUT

AI-generated

Overview

This node performs a PUT request to the SmartSuite API at a specified relative URL path. It allows users to update resources in SmartSuite by sending data via the API. The node supports adding query parameters, headers, and a request body, either by specifying fields or raw JSON. This is useful for updating existing records, tables, solutions, or other resources in SmartSuite programmatically.

Use Case Examples

  1. Updating a record in SmartSuite by specifying the record ID in the URL and sending updated field values in the request body.
  2. Modifying a solution configuration by sending a PUT request with JSON body data to the appropriate API endpoint.

Properties

Name Meaning
url The relative URL path to the SmartSuite API endpoint where the PUT request will be sent.
sendQuery Whether to include query parameters in the request URL.
queryParameters The list of query parameters as name-value pairs to include in the request URL if 'sendQuery' is true and 'specifyQuery' is set to 'fields'.
jsonQuery Raw JSON string representing query parameters to include in the request URL if 'sendQuery' is true and 'specifyQuery' is set to 'json'.
sendHeaders Whether to include HTTP headers in the request.
headerParameters The list of HTTP headers as name-value pairs to include in the request if 'sendHeaders' is true and 'specifyHeaders' is set to 'fields'.
jsonHeaders Raw JSON string representing HTTP headers to include in the request if 'sendHeaders' is true and 'specifyHeaders' is set to 'json'.
sendBody Whether to include a request body in the PUT request.
bodyParameters The list of body parameters as name-value pairs to include in the request body if 'sendBody' is true and 'specifyBody' is set to 'fields'.
jsonBody Raw JSON string representing the request body to include in the PUT request if 'sendBody' is true and 'specifyBody' is set to 'json'.

Output

JSON

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

Dependencies

  • SmartSuite API key credential

Troubleshooting

  • Ensure the URL path is correct and relative to 'app.smartsuite.com/api/v1'.
  • If sending query parameters or headers, verify their format and correctness.
  • If sending a request body, ensure the JSON or fields are properly formatted and valid according to the SmartSuite API documentation.
  • Common errors include authentication failures (check API key), invalid URL or parameters (check endpoint and parameters), and malformed JSON in body or headers.

Links

Discussion