Actions99
- Group Accounts Actions
- Group Account Codes Actions
- Accounts Actions
- Expenses Actions
- Purchase Orders Actions
- Get A List Of Purchase Orders
- Create A New Purchase Order
- Get A Purchase Order
- Update A Purchase Order
- Open A Purchase Order
- Get A List Of Purchase Orders Items For A Specific Purchase Order
- Create A Purchase Order Item
- Get A Purchase Order Item
- Update A Purchase Order Item
- Delete A Purchase Order Item
- Get A List Of Goods Received Notes For A Specific Purchase Order
- Create A Goods Received Note
- Attach A File To A Goods Received Note
- Delete A Goods Received Note
- Suppliers Actions
- Fund Accounts Actions
- Cards Actions
- Expense Categories Actions
- Tax Rates Actions
- Amortizations Actions
- Account Teams Actions
- Account Codes Actions
- External Teams Actions
- Custom Fields Actions
- Get Custom Fields
- Create A New Custom Field
- Get Custom Field
- Update Custom Field
- Delete A Custom Field And All Its Values
- Get Custom Field Values
- Create A Custom Field Value
- Delete Custom Field Values
- Get A Custom Field Value
- Update A Custom Field Value
- Delete A Custom Field Value
- Get Managers For A Specific Custom Field Value
- Adds Managers For A Specific Custom Field Value
- Replaces Managers For A Specific Custom Field Value
- Removes Managers For A Specific Custom Field Value
- Webhook Subscriptions Actions
- Group Teams Actions
Overview
This node operation updates a user's role and optionally their external identifier within a specified account. It is useful in scenarios where user permissions or roles need to be changed dynamically, such as promoting an employee to an admin role or adjusting access levels for accounting purposes. For example, a company might automate the process of updating user roles when employees change departments or responsibilities.
Properties
| Name | Meaning |
|---|---|
| Account Id | Identifier of the account to which the user belongs. |
| User Id | Identifier of the user whose details are being updated. |
| Role | New role assigned to the user. Options: Admin, Accounting, Employee. |
| External Id | Unique identifier of the account user in an external system (optional). |
Output
The node outputs JSON data representing the updated user information within the account. This typically includes confirmation of the changes made, such as the new role and any updated identifiers. The output does not include binary data.
Dependencies
- Requires an API key credential for authentication with the external service.
- The node uses a base URL configured in credentials to send requests.
- The node depends on the external API described by the bundled OpenAPI specification (
payhawk.api.json).
Troubleshooting
- Missing Required Fields: Ensure that both "Account Id" and "User Id" are provided; otherwise, the update will fail.
- Invalid Role Value: Only the predefined roles ("Admin", "Accounting", "Employee") are accepted. Providing an invalid role will cause an error.
- Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
- Network Issues: Check connectivity to the external API endpoint defined in the credentials.
- External Id Conflicts: If the external ID is already associated with another user, the API may reject the update.
Links and References
- OpenAPI Specification (referenced internally as
payhawk.api.json) - Documentation for the external API (not included in the source code bundle) should be consulted for detailed behavior of user role updates.