Payload CMS

Interact with Payload CMS collections and globals
Join our community

Actions18

Overview

This node interacts with Payload CMS collections, specifically supporting the 'Update' operation on collections. It allows users to update documents within a specified collection by sending JSON-formatted data. The node supports additional options such as depth of relationship population, pagination, sorting, filtering, field selection, and locale specification. This is useful for automating content management workflows, updating records programmatically, or integrating Payload CMS with other systems.

Use Case Examples

  1. Updating a blog post collection with new content fields.
  2. Modifying user data in a users collection based on external input.
  3. Automating updates to product information in an e-commerce collection.

Properties

Name Meaning
Collection The specific collection in Payload CMS to update documents in.
Data The JSON-formatted data representing the fields and values to update in the collection documents.
Additional Options Optional parameters to control the update operation, including depth of relationship population, limit of documents affected, pagination page, sorting order, filtering criteria (where clause), selected fields, and locale for localized content.

Output

JSON

  • json - The JSON response from Payload CMS containing the updated document(s) data.

Dependencies

  • An API key credential for Payload CMS authentication is required.

Troubleshooting

  • Authentication failures due to invalid or expired API tokens. Ensure credentials are correct and the Payload CMS instance is accessible.
  • Malformed JSON in the 'Data' or 'Where' fields can cause request errors. Validate JSON format before use.
  • Incorrect collection names or document IDs will result in errors. Verify collection existence and document identifiers.
  • Network or server errors from Payload CMS may occur; check the base URL and API prefix settings.

Links

Discussion