Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The "Sair Do Grupo" (Leave Group) operation in the "Grupo" (Group) resource allows a user to leave a specified group within the Zappfy API environment. This node is useful for automating group membership management, such as removing a user or bot from a group chat when certain conditions are met or workflows require it.

Practical examples include:

  • Automatically leaving a group after completing a task or event.
  • Managing group memberships dynamically based on external triggers.
  • Cleaning up group participations in bulk operations.

Properties

Name Meaning
Nome Da Instância The name of the instance to connect to. This identifies which Zappfy instance the operation will target.
ID Do Grupo The unique identifier (JID) of the group that the user wants to leave.

Output

The output of this node is a JSON array containing the response from the Zappfy API after attempting to leave the specified group. The exact structure depends on the API's response but typically includes confirmation of the action or error details if the operation failed.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to the Zappfy API via an API key credential configured in n8n.
  • The node uses the base URL https://docs.zappfy.io/api-reference for API requests.
  • Proper permissions and valid instance name and group ID must be provided to successfully perform the leave group operation.

Troubleshooting

  • Common issues:

    • Providing an incorrect or non-existent group ID will result in failure to leave the group.
    • Using an invalid or expired API key credential will cause authentication errors.
    • Specifying an incorrect instance name may lead to connection failures or targeting the wrong environment.

  • Error messages:

    • "Operação não suportada." indicates that the requested operation is not implemented or recognized by the node. Verify that the resource and operation names are correct.
    • API errors returned from Zappfy will be passed through; check the message for details such as permission denied or group not found.

To resolve these issues:

  • Double-check the input parameters for correctness.
  • Ensure the API credentials are valid and have necessary permissions.
  • Confirm the group ID exists and the instance name matches your Zappfy setup.

Links and References

Discussion