Apify icon

Apify

Apify API

Overview

This node updates an existing dataset on the Apify platform. It is useful for scenarios where you need to modify the metadata or properties of a dataset, such as renaming it or changing other dataset attributes. For example, you might use this node to update the name of a dataset after processing or to correct dataset details programmatically.

Use Case Examples

  1. Updating the name of a dataset by specifying its ID and the new name.
  2. Sending a custom JSON body to update multiple dataset properties at once.

Properties

Name Meaning
Dataset Id The unique identifier of the dataset to update, which can be a dataset ID or a combination of username and dataset name.
Name The new name to assign to the dataset. This is used when not using a custom body.
Use Custom Body A boolean flag to indicate whether to send a custom JSON body instead of the predefined parameters.
Custom Body A JSON object representing the custom body to send in the update request. This allows for more flexible updates beyond just the name.

Output

JSON

  • id - The unique identifier of the updated dataset.
  • name - The updated name of the dataset.
  • createdAt - Timestamp when the dataset was created.
  • modifiedAt - Timestamp when the dataset was last modified.
  • otherProperties - Any other dataset properties returned by the Apify API after the update.

Dependencies

  • Requires an Apify API key credential for authentication to access and update datasets on the Apify platform.

Troubleshooting

  • Ensure the Dataset Id is correct and exists; otherwise, the update will fail with a not found error.
  • If using a custom body, ensure the JSON is valid and matches the expected schema by the Apify API.
  • Authentication errors may occur if the Apify API key credential is missing or invalid; verify the credential configuration.
  • Network or API rate limit errors may occur; handle retries or backoff as needed.

Links

Discussion