WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

WhatsApp Numbers → Update Number

AI-generated

Overview

The "Update Number" operation for the WhatsApp Numbers resource allows users to modify the configuration and metadata of a specific WhatsApp number managed via the WaliChat API. This node operation is useful when you want to update settings such as enabling or disabling the number, changing its alias or description, adjusting billing plans, managing webhook notifications, setting reboot policies, retention policies, or controlling message delivery speed.

Practical examples include:

  • Disabling a WhatsApp number temporarily without deleting it.
  • Changing the display name (alias) of a WhatsApp number for easier identification.
  • Updating the billing plan to upgrade or downgrade service levels.
  • Restricting webhook notifications to certain endpoints for better event management.
  • Setting data retention policies to comply with privacy requirements.
  • Adjusting message delivery speed to control throughput and avoid rate limits.

Properties

Name Meaning
WhatsApp Number ID The unique identifier of the WhatsApp number to update. This is required to specify which number's settings will be changed.
Update Fields A collection of fields that can be updated for the WhatsApp number:
  Enable Boolean flag to enable (true) or disable (false) the WhatsApp number.
  Alias New alias or name for the WhatsApp number, must be between 2 and 30 characters.
  Description New description text for the WhatsApp number, up to 80 characters.
  Billing Plan Select a new billing plan for the WhatsApp number. Options include: Professional, Business, Enterprise, Gateway Professional, Gateway Business, Gateway Enterprise, Platform Professional, Platform Business, Platform Enterprise. Charges may apply.
  Webhook IDs List of webhook endpoint IDs to restrict notifications to only these endpoints. Multiple values allowed.
  Reboot Policy Device session reboot policy specifying how often the device should reboot. Options range from Disabled to intervals between 10 minutes and 18 hours.
  Retention Policy Data retention policy for the WhatsApp number. Options include Plan Defaults, Never, and various time intervals from 5 minutes up to 10 days.
  Delivery Speed Maximum message delivery speed per minute. Options range from Plan Default to specific numeric rates from 0.1 up to 150 messages per minute.

Output

The output JSON contains the response from the WaliChat API after updating the WhatsApp number. It typically includes the updated properties of the WhatsApp number such as its ID, alias, status (enabled/disabled), billing plan, webhook restrictions, reboot and retention policies, and delivery speed settings.

No binary data output is expected from this operation.

Dependencies

  • Requires an active API key credential for authenticating with the WaliChat WhatsApp API.
  • The node depends on the WaliChat API service being accessible and properly configured.
  • Proper permissions on the API key to update WhatsApp numbers are necessary.
  • No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

  • Common Issues:

    • Invalid WhatsApp Number ID: Ensure the provided ID corresponds to an existing WhatsApp number in your account.
    • Validation errors on fields like alias length or description length.
    • Insufficient permissions on the API key to perform updates.
    • Network or connectivity issues preventing access to the WaliChat API.
  • Error Messages:

    • "WhatsApp Number not found": Check that the WhatsApp Number ID is correct.
    • "Invalid alias length": Alias must be between 2 and 30 characters.
    • "Unauthorized" or "Forbidden": Verify API key permissions.
    • "Rate limit exceeded": Reduce delivery speed or check API usage limits.
  • Resolution Tips:

    • Double-check all input parameters for correctness.
    • Confirm API key validity and permissions.
    • Review API documentation for field constraints.
    • Use smaller batch sizes or slower delivery speeds if hitting rate limits.

Links and References

Discussion