Zappfy API icon

Zappfy API

Interact with Zappfy API

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 Configurações" (Update Settings), it updates group settings such as who can send messages or edit configurations within a group.

Common scenarios include managing group communication policies in messaging platforms where administrators want to control message sending permissions or configuration editing rights. For example, an admin might restrict message sending to only admins during announcements or allow all members to send messages normally.

Properties

Name Meaning
Nome Da Instância The name of the instance where the group exists; identifies the target environment.
ID Do Grupo The unique identifier of the group whose settings are to be updated.
Ação The setting action to apply on the group. Options:
- Somente Admins Enviam Mensagens (Only admins can send messages)
- Todos Enviam Mensagens (Everyone can send messages)
- Somente Admins Editam Configurações (Only admins can edit settings)
- Todos Editam Configurações (Everyone can edit settings)

Output

The node outputs a JSON array containing the result of the update operation. The exact structure depends on the API response but typically includes confirmation of the applied settings or error details if the update failed.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Zappfy API.
  • The base URL for API requests is https://docs.zappfy.io/api-reference.
  • Proper configuration of the API credential in n8n is necessary for successful execution.

Troubleshooting

  • Unsupported Operation 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-settings" respectively.
  • Authentication Failures: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid Group ID: Providing an incorrect or non-existent group ID will cause the update to fail; double-check the group identifier.
  • Missing Required Parameters: All required properties must be provided; missing "Nome Da Instância", "ID Do Grupo", or "Ação" will prevent execution.

Links and References

Discussion