z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node interacts with the Z-API service to add a new contact to a WhatsApp instance. It is useful for automating the process of managing contacts within WhatsApp, such as adding new phone numbers with associated contact names. Practical examples include integrating with CRM systems to automatically add customer contacts or managing contact lists for marketing campaigns.

Use Case Examples

  1. Add a new contact by providing the phone number and contact name to keep the WhatsApp contact list updated automatically.
  2. Use in workflows where new leads are captured and need to be added as contacts in WhatsApp for follow-up messaging.

Properties

Name Meaning
Phone Number The phone number of the contact to add, entered as digits only without any formatting.
Contact Name The name of the contact to be added, used to identify the contact in WhatsApp.

Output

JSON

  • phone - The phone number of the added contact.
  • contactName - The name of the added contact.
  • status - The result status of the add contact operation, indicating success or failure.

Dependencies

  • Requires an API key credential for Z-API to authenticate requests to the WhatsApp service.

Troubleshooting

  • Ensure the phone number is provided in the correct format (digits only, no formatting) to avoid validation errors.
  • If the API key credential is invalid or missing, the node will fail to authenticate with the Z-API service.
  • Network issues or service downtime of Z-API can cause operation failures; check connectivity and service status.
  • Error messages typically include details about invalid input or authentication failures; verify input parameters and credentials accordingly.

Links

Discussion