Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

This node interacts with the Zappfy API to perform various operations related to groups. Specifically, for the "Grupo" resource and the "Atualizar Descrição Do Grupo" operation, it updates the description of a specified group within a given instance. This is useful in scenarios where group metadata needs to be kept current, such as updating group purpose or rules after changes in team structure or project scope.

Practical examples include:

  • Automatically updating group descriptions when project phases change.
  • Synchronizing group information across multiple platforms by programmatically setting descriptions.
  • Managing large numbers of groups by batch updating their descriptions via workflows.

Properties

Name Meaning
Nome Da Instância The name of the instance where the group description will be updated.
ID Do Grupo The unique identifier (JID) of the group whose description is to be updated.
Nova Descrição The new description text that will be set for the specified group.

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to update the group description. The exact structure depends on the API's response but typically includes confirmation of success or details about the updated group.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is purely JSON-based.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for API requests is https://docs.zappfy.io/api-reference.
  • Proper configuration of the node’s credentials in n8n is necessary for successful execution.

Troubleshooting

  • Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "groups-api" and "update-group-description" respectively.
  • Authentication Failures: Ensure the API key or token credential is valid and has sufficient permissions to update group descriptions.
  • Invalid Group ID: Errors may occur if the provided group ID does not exist or is malformed; double-check the group JID.
  • Empty or Missing Required Fields: All three properties ("Nome Da Instância", "ID Do Grupo", and "Nova Descrição") are required. Omitting any will cause errors.
  • API Rate Limits or Network Issues: Temporary failures might happen due to network problems or API rate limiting; retrying after some time can help.

Links and References

Discussion