Zappfy API icon

Zappfy API

Interact with Zappfy API

Overview

The node "Zappfy API" allows interaction with the Zappfy service through its API. Specifically, for the resource Grupo and operation Buscar Link De Convite, it fetches an invitation link code for a specified group. This is useful in scenarios where you want to programmatically retrieve invite codes to share or manage group access without manually accessing the group interface.

Practical examples include:

  • Automating the retrieval of invite links for multiple groups to distribute them via other communication channels.
  • Integrating group invite management into workflows that require dynamic group membership control.

Properties

Name Meaning
Nome Da Instância The name of the instance from which to fetch the invite code.
ID Do Grupo The unique identifier (JID) of the group for which the invite code will be retrieved.

Output

The node outputs a JSON array containing the result of the invite code fetch operation. Each item in the array corresponds to the data returned by the Zappfy API for the requested group invite code. The exact structure depends on the API response but typically includes fields related to the invite link/code.

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 within 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 as "groups-api" and "fetch-invite-code" respectively.
  • Missing Required Parameters: Ensure both "Nome Da Instância" and "ID Do Grupo" are provided; missing these will cause errors.
  • Authentication Failures: Confirm that the API key credential is valid and has the necessary permissions.
  • API Endpoint Issues: Network issues or incorrect base URL configurations can lead to request failures.

Links and References

Discussion