N8N Tools - Uazapi icon

N8N Tools - Uazapi

Complete Uazapi integration - Premium WhatsApp API with advanced messaging and automation

Actions37

Overview

The node integrates with the Uazapi WhatsApp API to manage and automate WhatsApp instance settings, specifically focusing on the "Instance" resource's "Set Profile" operation. This operation allows users to update their WhatsApp profile information programmatically.

Typical use cases include:

  • Automatically updating the WhatsApp profile details of a business or service as part of an automation workflow.
  • Synchronizing profile information across multiple WhatsApp instances.
  • Managing profile updates triggered by external events or data changes.

For example, a user might update their WhatsApp profile name or status message dynamically based on marketing campaigns or customer interactions.

Properties

Name Meaning
Additional Fields Optional fields to customize the profile update request. Includes:
- Reply to Message ID: ID of a message to reply to (string)
- Delay (seconds): Delay before sending the update (number)
- Disable Link Preview: Whether to disable link previews in messages (boolean)
- Mention Users: Comma-separated phone numbers to mention in the update (string)

Note: The "Additional Fields" collection allows adding optional parameters that modify how the profile update is processed.

Output

The node outputs a JSON object containing the response from the Uazapi API after attempting to set the profile. The structure depends on the API response but generally includes confirmation of the profile update or error details if the operation failed.

No binary data output is produced by this operation.

Example output snippet (conceptual):

{
  "status": "success",
  "message": "Profile updated successfully",
  "profile": {
    "name": "New Profile Name",
    "status": "Available"
  }
}

Dependencies

  • Requires an active Uazapi WhatsApp API account with valid credentials including:

    • An API key credential for authentication.
    • API URL endpoint.
    • API token.
    • Instance ID identifying the WhatsApp instance to update.

  • The node uses these credentials to authenticate and send requests to the Uazapi service.

  • No additional environment variables are required beyond the configured credentials.

Troubleshooting

  • Common Issues:

    • Invalid or expired API token causing authentication failures.
    • Incorrect instance ID leading to "instance not found" errors.
    • Missing required fields in the "Additional Fields" collection if the API expects certain profile attributes.
    • Network connectivity issues preventing communication with the Uazapi API.

  • Error Messages:

    • "Unknown resource: instance": Indicates the resource parameter was incorrectly set; ensure it is exactly "instance".
    • API authorization errors: Check that the API key and token are correctly configured and have sufficient permissions.
    • Validation errors from the API: Review the provided profile fields for correctness and completeness.

  • Resolution Tips:

    • Verify all credential values are current and correct.
    • Confirm the instance ID matches the target WhatsApp instance.
    • Use the node's error output to inspect detailed API error messages.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch processing.

Links and References

Discussion