Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" allows interaction with the Zappfy service through its API. Specifically, for the resource Perfil and operation Buscar Perfil Profissional, it fetches professional profile information associated with a given contact number. This is useful in scenarios where you want to retrieve detailed professional data about a contact from the Zappfy platform, such as in customer relationship management, marketing automation, or contact enrichment workflows.

For example, you might use this node to automatically pull professional details of a client or lead based on their contact number, enabling personalized communication or data analysis.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance to connect to. It identifies which instance to query.
Contato The contact number (remoteJid) whose professional profile you want to fetch.

Output

The node outputs a JSON array containing the fetched professional profile data for the specified contact. Each item in the output array represents the profile information returned by the Zappfy API for that contact.

If the API supports binary data (e.g., profile images), it would be included accordingly, but based on the provided code and properties, the primary output is structured JSON data representing the professional profile.

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 requests is set to https://docs.zappfy.io/api-reference.
  • The node depends on the internal implementation of resource-operation functions (resourceOperationsFunctions) which handle the actual API calls.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation for the resource, the node throws an error indicating the operation is not supported. Ensure you choose valid combinations of resource and operation.
  • Missing required parameters: Both "Nome Da Instância" and "Contato" are required. Omitting them will likely cause errors or empty responses.
  • API connectivity issues: Network problems or invalid credentials can cause request failures. Verify your API key/token and network access.
  • Unexpected API response: If the API changes or returns unexpected data, the node may fail or return incomplete results. Check the API documentation and update the node or credentials accordingly.

Links and References

Discussion