Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" allows interaction with the Zappfy service, specifically providing operations related to groups management. The operation "Entrar No Grupo" (Join Group) enables an instance to join a specified group using an invite code. This is useful in scenarios where automated workflows need to programmatically add instances to groups for messaging or collaboration purposes.

Practical examples include:

  • Automatically joining a marketing campaign group when a new instance is created.
  • Adding customer support bots to specific client groups based on invite codes.
  • Managing group memberships dynamically within automation workflows.

Properties

Name Meaning
Nome Da Instância The name of the instance that will join the group.
Código Do Convite The invite code of the group to join (e.g., JZNHJLvnNd04UvGefiEZAA).

Output

The node outputs a JSON array containing the result of the join group operation. The exact structure depends on the API response but typically includes confirmation details such as success status, group information, or error messages if the join 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

  • 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 "join-group" respectively.
  • Invalid invite code: Providing an incorrect or expired invite code may cause the API to reject the request. Double-check the invite code value.
  • Instance name missing or invalid: Ensure the instance name is provided and valid; otherwise, the join operation might fail.
  • Authentication errors: Confirm that the API key credential is correctly configured and has sufficient permissions.
  • Network issues: Connectivity problems to the API endpoint can cause failures; check network access and proxy settings if applicable.

Links and References

Discussion