Appwrite icon

Appwrite

Interact with Appwrite API

Actions181

Messaging → Update Provider

AI-generated

Overview

This node interacts with the Appwrite API to update messaging providers. It allows users to modify the configuration of various messaging providers such as Sendgrid, Mailgun, Twilio, FCM, and APNS. This is useful for managing email, SMS, and push notification services within an application, enabling updates to provider credentials, sender information, and other provider-specific settings.

Use Case Examples

  1. Updating the API key and sender email for a Sendgrid email provider.
  2. Changing the Twilio account SID and auth token for SMS messaging.
  3. Modifying the FCM service account JSON for push notifications.

Properties

Name Meaning
Provider ID The unique identifier of the messaging provider to update.
Provider Type The type of messaging provider (e.g., Sendgrid, Mailgun, Twilio, FCM, APNS).
Name The name of the provider; can be left empty to keep the current name.
Enabled Whether the provider is enabled or disabled.
API Key API key for email providers (Sendgrid, Mailgun).
Domain Mailgun domain for the Mailgun email provider.
From Email Sender email address for email providers (Sendgrid, Mailgun).
From Name Sender name for email providers (Sendgrid, Mailgun).
From Sender phone number for SMS provider (Twilio).
Account SID Twilio Account SID for SMS provider.
Auth Token Twilio Auth Token for SMS provider.
Server Key FCM service account JSON object for push notifications.
Auth Key APNS authentication key for push notifications.
Auth Key ID APNS authentication key ID for push notifications.
Team ID APNS team ID for push notifications.
Bundle ID APNS bundle ID for push notifications.
Sandbox Whether to use the APNS sandbox environment for push notifications.

Output

JSON

  • id - The unique identifier of the updated messaging provider.
  • type - The type of the messaging provider.
  • name - The name of the messaging provider.
  • enabled - Indicates if the provider is enabled.
  • settings - The configuration settings of the messaging provider, including credentials and sender information.

Dependencies

  • Appwrite API key credential

Troubleshooting

  • Ensure the Provider ID is correct and exists in the Appwrite system to avoid 'Unknown provider' errors.
  • Verify that the API key and other credentials are valid and have the necessary permissions.
  • Check that the provider type matches the credentials and settings provided to prevent configuration errors.
  • If the node fails, check the error message for details; enabling 'Continue On Fail' can help process multiple items without stopping on errors.

Links

Discussion