Actions84
- Avatar Actions
- Document Actions
- Function Actions
- Messaging Actions
- Create APNS Provider
- Create Email
- Create FCM Provider
- Create Mailgun Provider
- Create MSG91 Provider
- Create Provider
- Create Push
- Create Sendgrid Provider
- Create SMS
- Create SMTP Provider
- Create Subscriber
- Create Telesign Provider
- Create Textmagic Provider
- Create Topic
- Create Twilio Provider
- Create Vonage Provider
- Delete Provider
- Delete Subscriber
- Delete Topic
- Get Message
- Get Provider
- Get Subscriber
- Get Topic
- List Message Logs
- List Messages
- List Provider Logs
- List Providers
- List Subscriber Logs
- List Subscribers
- List Targets
- List Topic Logs
- List Topics
- Update APNS Provider
- Update Email
- Update FCM Provider
- Update Mailgun Provider
- Update MSG91 Provider
- Update Provider
- Update Push
- Update Sendgrid Provider
- Update SMS
- Update SMTP Provider
- Update Telesign Provider
- Update Textmagic Provider
- Update Topic
- Update Twilio Provider
- Update Vonage Provider
- Storage Actions
- Token Actions
- Users Actions
Overview
The node integrates with the Appwrite API to update user information. It allows modifying various user attributes such as email, name, phone number, password, preferences, labels, and status. This operation is useful in scenarios where you need to programmatically manage user profiles within an Appwrite backend, for example:
- Updating a user's contact details or verifying their email/phone.
- Changing a user's password or setting a new one.
- Adjusting user preferences or labels for segmentation.
- Enabling or disabling a user account without deleting it.
Practical example: Automatically update user preferences and verify their phone number after they complete a profile form on your website.
Properties
| Name | Meaning |
|---|---|
| User ID | The unique identifier of the user to update. |
| The user's email address to set or update. | |
| Verify Email? | Boolean flag indicating whether to verify the user's email address. |
| Name | The full name of the user. |
| Phone | The user's phone number. |
| Verify Phone? | Boolean flag indicating whether to verify the user's phone number. |
| Password | The current password of the user (required for authentication when updating). |
| New Password | A new password to update the user's password to. |
| Preferences | JSON object representing user preferences to create or update. |
| Labels | JSON array of strings representing labels to assign to the user. |
| Status | Boolean indicating if the user is enabled (true) or disabled/fake deleted (false). |
Output
The output is a JSON object representing the updated user data returned from the Appwrite API. It typically includes fields such as user ID, email, name, phone, verification statuses, preferences, labels, and status among others depending on the API response.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Appwrite API via an API key credential.
- The node expects credentials containing the Appwrite endpoint URL, project ID, and an API key.
- No additional environment variables are required beyond the configured credentials.
Troubleshooting
Common issues:
- Invalid or missing User ID will cause the update to fail.
- Incorrect current password may prevent password updates.
- Insufficient permissions or invalid API key can result in authorization errors.
- Malformed JSON in Preferences or Labels fields can cause parsing errors.
Error messages:
- Errors from the Appwrite API will be propagated, often indicating the reason such as "User not found", "Invalid credentials", or "Malformed request".
- To resolve, verify all required parameters, ensure correct credentials, and validate JSON inputs.