Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

This node, named "Zappfy API," allows users to interact with the Zappfy service via its API. Specifically, for the resource "Grupo" and operation "Atualizar Nome Do Grupo" (Update Group Name), it updates the name of an existing group within a specified instance. This is useful in scenarios where group names need to be changed dynamically based on business logic or user input, such as renaming project teams, event groups, or chat channels.

Practical example: Suppose you manage multiple chat groups for different departments in your organization. When a department changes its name or focus, you can use this node to automatically update the corresponding group name in Zappfy without manual intervention.

Properties

Name Meaning
Nome Da Instância The name of the instance where the group exists and whose group name will be updated.
ID Do Grupo The unique identifier (ID) of the group whose name you want to update.
Novo Nome Do Grupo The new name that will be assigned to the group.

Output

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

No binary data output is indicated by the source code.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication credential configured in n8n (referred generically as an API key or token).
  • The base URL for API requests is https://docs.zappfy.io/api-reference.
  • The node expects JSON content-type headers for communication.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error stating the operation is not supported. Ensure you use valid combinations of resource and operation.
  • Missing required properties: All three properties (Nome Da Instância, ID Do Grupo, and Novo Nome Do Grupo) are required. Omitting any will likely cause the API call to fail.
  • API authentication errors: If the API key or token is invalid or missing, the request will fail. Verify credentials are correctly set up in n8n.
  • Network or API endpoint issues: Since the base URL points to the API reference documentation URL, ensure the actual API endpoint URL is correctly configured in the node or credentials if different.

Links and References

Discussion