Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
This node allows updating a user on the platform by specifying the user's numeric ID and optionally modifying their name, email, password, and custom attributes. It is useful in scenarios where user information needs to be programmatically maintained or synchronized, such as updating user profiles after registration changes, correcting user details, or managing user data in bulk.
Practical examples include:
- Automatically updating a user's email address when it changes in an external system.
- Changing a user's password based on a reset request.
- Adding or modifying custom metadata associated with a user for segmentation or personalization purposes.
Properties
| Name | Meaning |
|---|---|
| Id | The numeric ID of the user on the platform (required). |
| Name | The new name of the user to update. |
| The new email address of the user. | |
| Password | The new password for the user. Must contain uppercase, lowercase letters, a number, and a special character. |
| Custom Attributes | JSON object representing custom attributes to associate with the user. |
Output
The node outputs JSON data representing the updated user object returned from the platform's API. This typically includes the user's updated fields such as id, name, email, and any custom attributes. There is no binary data output.
Dependencies
- Requires an API key credential for authenticating with the platform.
- Needs the base URL of the platform's API configured in the credentials.
- Depends on the platform's REST API endpoint for updating users.
Troubleshooting
- Invalid User ID: If the provided user ID does not exist, the API will likely return an error indicating the user was not found. Verify the ID before running the node.
- Password Validation Errors: Passwords must meet complexity requirements (uppercase, lowercase, number, special character). Failure to comply will cause the update to fail.
- Malformed JSON in Custom Attributes: Ensure that the JSON string provided for custom attributes is valid; otherwise, parsing errors will occur.
- Authentication Failures: Check that the API key credential is correctly set up and has sufficient permissions to update users.
- API Endpoint Issues: Confirm the base URL is correct and the platform API is reachable.
Links and References
- Platform API documentation for user management (update user endpoint).
- JSON syntax guides for constructing valid custom attributes.
- Password policy guidelines for the platform.