Pulse Account Action icon

Pulse Account Action

Account actions from Pulse API

Actions9

Overview

This node enables managing account roles within the Pulse API system. Specifically, the "Add New Account Role" operation allows users to assign a new role to an account by specifying details such as the account ID, role type, and additional contextual information depending on the role chosen.

Common scenarios for this node include:

  • Assigning administrative or staff roles to user accounts in an organization.
  • Adding client roles linked to specific organizations.
  • Defining project-related roles like Lead or Staff with associated project IDs.
  • Managing organizational structure roles such as Office Manager, HR Staff, or Production Manager with their respective organizational units.

Practical example:
A company wants to add a new "Lead" role to an employee's account and associate that role with multiple projects they will oversee. Using this node, the user can specify the account ID, select the "Lead" role, and provide a comma-separated list of project IDs to link.

Properties

Name Meaning
Account ID * The unique identifier of the account to which the role will be added.
Role Name * The name of the role to assign. Options: Admin, HR Staff, Staff, Lead, Office Manager, Production Manager, Client.
Organization ID * The ID of the organization. Required only if the selected role is "Client".
Organizational Unit * The organizational unit within the company. Required if the role is one of: Office Manager, HR Staff, or Production Manager.
Project IDs * Comma-separated list of project IDs. Required if the role is "Lead" or "Staff".

Note: Fields marked with * are required based on the role selected.

Output

The node outputs a JSON object representing the newly created account role. This typically includes details such as the assigned role name, associated account ID, and any linked organization, organizational unit, or projects depending on the role.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Pulse API via an API key credential configured in n8n.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase to perform API calls.
  • Proper permissions on the Pulse API side to create or modify account roles.

Troubleshooting

  • Missing Required Fields: If the role requires additional fields (e.g., Organization ID for Client role) and these are not provided, the API call may fail. Ensure all required properties for the selected role are filled.
  • Invalid Account ID: Providing an incorrect or non-existent account ID will result in errors from the API indicating the account was not found.
  • Malformed Project IDs: For roles requiring project IDs, ensure the input is a properly formatted comma-separated string without extra spaces or invalid characters.
  • API Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Unsupported Role Names: Only the predefined role names listed in the options are accepted; using custom or unsupported role names will cause failures.

Links and References

Discussion