ZAppwrite icon

ZAppwrite

Use Appwrite's API from inside N8N, updated by @ZachHandley

Overview

This node operation updates an existing MSG91 messaging provider configuration within the Appwrite platform. It allows users to modify key details such as the provider's name, enabled status, sender ID, and authentication key for MSG91. This is useful in scenarios where you need to maintain or change your SMS sending service credentials or settings without creating a new provider from scratch.

Practical examples include:

  • Updating the authentication key after rotating API keys for security.
  • Changing the sender ID used in SMS messages.
  • Enabling or disabling the MSG91 provider dynamically based on business needs.

Properties

Name Meaning
Provider ID Unique identifier of the MSG91 provider to update.
Provider Name The display name for the MSG91 provider.
Enabled Boolean flag indicating whether the MSG91 provider is active (enabled) or not.
Sender ID The sender ID used by MSG91 to send SMS messages.
Auth Key The authentication key (API key) for MSG91 to authorize requests.
Template ID (Optional) MSG91 template ID associated with the provider (not required for update but available).

Note: Some properties have multiple naming variants depending on context (senderId vs senderIdDirect, authKey vs authKeyDirectMsg91). For the update operation, the direct versions are used (senderIdDirect, authKeyDirectMsg91).

Output

The output is a JSON object representing the updated MSG91 provider resource as returned by the Appwrite API. It typically includes fields such as:

  • Provider ID
  • Provider Name
  • Enabled status
  • Sender ID
  • Authentication key (usually masked or omitted for security)
  • Other metadata related to the provider

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to an Appwrite server with appropriate API credentials (project ID, API key).
  • The node depends on the Appwrite SDK and internal helper functions to communicate with the Appwrite Messaging API.
  • Proper permissions to update messaging providers in the Appwrite project are necessary.

Troubleshooting

  • Invalid Provider ID: If the specified Provider ID does not exist, the node will throw an error indicating the provider was not found. Verify the Provider ID is correct.
  • Authentication Errors: Incorrect or expired API keys will cause authentication failures. Ensure the API key credential is valid and has sufficient permissions.
  • Missing Required Fields: Omitting required parameters like Provider ID or Provider Name will result in validation errors.
  • Network Issues: Connectivity problems with the Appwrite server can cause timeouts or request failures.
  • Permission Denied: Insufficient permissions to update messaging providers will lead to authorization errors.

To resolve these issues, verify all input parameters, check API credentials, and ensure network connectivity to the Appwrite instance.

Links and References

Discussion