Pulse Account Action icon

Pulse Account Action

Account actions from Pulse API

Actions9

Overview

The node performs actions related to account roles within the Pulse API. Specifically, for the "Update Account Role" operation, it updates an existing account role's details such as its name and associated scopes (permissions). This is useful in scenarios where you need to modify user roles dynamically, for example, changing a staff member’s role from "Staff" to "Lead" or updating the permissions assigned to a particular role.

Practical examples:

  • Updating the role name of an account role to reflect a change in organizational structure.
  • Modifying the scopes (permissions) of a role to grant or restrict access to certain projects or resources.

Properties

Name Meaning
Account Role ID * The unique identifier of the account role to update.
Role Name * The new name for the role. Options: Admin, HR Staff, Staff, Lead, Office Manager, Production Manager, Client.
Additional Fields Optional additional fields to update.
- Scopes A JSON string defining the scopes (resources and permissions) for the role. Example: {"project": ["project_id_1", "project_id_2"]}

Output

The output is a JSON object representing the updated account role after the operation completes successfully. It contains the updated properties of the account role, including its ID, name, and scopes.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Pulse API.
  • The node depends on the Pulse API helper utilities bundled within the node package to perform HTTP requests.
  • Proper configuration of the API credential in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing Account Role ID will cause the update to fail.
    • Malformed JSON in the "Scopes" field can lead to errors when parsing or sending the request.
    • Insufficient permissions associated with the API key may prevent updating roles.

  • Error messages:

    • "The operation "updateAccountRole" is not supported for resource "accountRole"!" — indicates a misconfiguration of the operation parameter.
    • Errors returned from the Pulse API typically include messages about invalid IDs or permission issues; ensure the provided role ID exists and the API key has adequate rights.

  • Resolutions:

    • Verify that the Account Role ID is correct and exists in the system.
    • Validate the JSON format of the scopes before inputting.
    • Check API credentials and permissions.

Links and References

Discussion