Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" provides integration with the Zappfy service, allowing users to perform various operations on resources managed by Zappfy. Specifically, for the resource Grupo and operation Atualizar Membros, this node enables managing group participants by adding, removing, promoting, or demoting members within a specified group.

This node is beneficial in scenarios where automated management of group memberships is required, such as:

  • Adding new members to a chat group automatically after registration.
  • Removing inactive or unauthorized members from groups.
  • Promoting trusted members to administrators to delegate moderation.
  • Demoting administrators when necessary to maintain group hierarchy.

Practical example: A company uses this node to update WhatsApp group participants dynamically based on employee status changes, ensuring only current employees have access and appropriate roles.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance to connect to.
ID Do Grupo The unique identifier (JID) of the group whose members will be updated.
Ação The action to perform on the members. Options: Add Member, Remove Member, Promote to Admin, Demote to Member.
Membros Comma-separated list of phone numbers representing the members to be affected by the action (e.g., 5511999999999,5511888888888).

Output

The node outputs a JSON array containing the result of the executed operation. Each item in the output corresponds to the response from the Zappfy API after attempting to update the group members according to the specified action. The exact structure depends on the API response but generally includes confirmation of success or failure for each member processed.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Zappfy API service.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for API requests is https://docs.zappfy.io/api-reference.
  • Proper configuration of the "Nome Da Instância" property to target the correct Zappfy environment.

Troubleshooting

  • Common issues:

    • Invalid or missing group ID (ID Do Grupo) can cause failures in locating the group.
    • Incorrectly formatted member phone numbers in the Membros field may lead to errors or ignored entries.
    • Insufficient permissions or invalid API credentials will result in authorization errors.
    • Unsupported actions or typos in the Ação property could trigger "Operation not supported" errors.

  • Error messages:

    • "Operação não suportada." indicates that the selected operation is not implemented for the chosen resource. Verify that the resource and operation names are correct.
    • API errors related to authentication or request validation should be resolved by checking credentials and input formats.

Links and References

Discussion