Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" allows interaction with the Zappfy platform via its API. Specifically, for the resource Perfil and operation Atualizar Status, it updates the status message of a user profile instance on Zappfy. This is useful in scenarios where you want to programmatically change or set the status text of a profile, such as reflecting availability, mood, or any custom status message.

Practical examples include:

  • Automatically updating a user's profile status based on external triggers (e.g., calendar events, system alerts).
  • Setting a default status message when a new profile instance is created.
  • Changing status messages dynamically during workflows to reflect current states.

Properties

Name Meaning
Nome Da Instância The name of the profile instance whose status you want to update.
Status The new status message for the profile. It must be a string with a maximum length of 139 characters.

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to update the profile status. The exact structure depends on the API response but typically includes confirmation of the updated status 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 requests is https://docs.zappfy.io/api-reference.
  • Proper configuration of the API authentication within n8n credentials is necessary.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the operation is not supported. Ensure that the resource is "profile-api" and the operation is "update-profile-status".
  • Invalid or missing parameters: The "Nome Da Instância" and "Status" fields are required. Missing or empty values will likely cause the API call to fail.
  • Status length exceeded: The status message must not exceed 139 characters; longer inputs may cause errors.
  • Authentication errors: Make sure the API key credential is correctly configured and valid.
  • API connectivity issues: Network problems or incorrect base URL settings can prevent successful API calls.

Links and References

Discussion