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 platform via its API. Specifically, for the resource "Perfil" and operation "Atualizar Foto Do Perfil" (Update Profile Picture), it updates the profile picture of a specified instance by setting a new image URL. This is useful in scenarios where you want to programmatically change or refresh the profile photo associated with an account or service instance on Zappfy.

Practical examples include:

  • Automatically updating a user or bot profile picture based on external triggers.
  • Synchronizing profile images across multiple platforms by pushing updates through this node.
  • Managing branding or personalization dynamically by changing profile pictures without manual intervention.

Properties

Name Meaning
Nome Da Instância The name of the instance whose profile picture will be updated.
URL Da Imagem The URL of the image that will be set as the new profile picture.

Output

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

If the API supports binary data output (e.g., returning the image or related files), it would be included accordingly, but based on the provided code and properties, the primary output is JSON data reflecting the operation result.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • The base URL for requests is set to https://docs.zappfy.io/api-reference, which should be accessible from the environment where n8n runs.

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 "Perfil" and "Atualizar Foto Do Perfil" respectively.
  • Authentication Issues: Ensure the API key or authentication token is valid and has permissions to update profile pictures.
  • Invalid Image URL: If the provided image URL is invalid or inaccessible, the API may reject the request. Confirm the URL points to a publicly accessible image.
  • Network Errors: Check network connectivity to the Zappfy API endpoint.
  • Missing Required Properties: Both "Nome Da Instância" and "URL Da Imagem" are required; missing either will cause errors.

Links and References

Discussion