Pulse Account Action icon

Pulse Account Action

Account actions from Pulse API

Actions9

Overview

This node allows users to manage account roles within the Pulse API system. Specifically, the "Add New Account Role" operation lets you create a new role for an account, assigning specific permissions and organizational context based on the role type. This is useful in scenarios where you want to programmatically assign roles such as Admin, HR Staff, Lead, or Client to users within an account, enabling role-based access control and organization-specific configurations.

Practical examples:

  • Automatically adding a "Client" role with an associated organization ID when onboarding a new client user.
  • Assigning "Lead" or "Staff" roles with project associations to team members during project setup.
  • Creating an "Office Manager" role linked to a particular organizational unit for administrative purposes.

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 role is "Client".
Organizational Unit * The organizational unit; required if the role is "Office Manager", "HR Staff", or "Production Manager".
Project IDs * Comma-separated list of project IDs; required if the role is "Lead" or "Staff".

*Fields marked with * are required under certain conditions as described.

Output

The output JSON contains the result of the "Add New Account Role" operation. It typically includes details about the newly created account role such as its ID, assigned role name, associated account ID, and any linked organizational or project information.

If the node supports binary data output (not indicated here), it would represent related files or attachments, but this operation focuses on JSON data representing account role entities.

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 with the node implementation to perform authenticated requests.
  • Proper permissions on the Pulse API side to create or modify account roles.

Troubleshooting

  • Missing Required Fields: Errors may occur if required fields for specific roles are not provided (e.g., missing organization_id for Client role). Ensure all conditional required properties are set.
  • Invalid Role Name: Selecting a role name outside the predefined options will cause errors.
  • API Authentication Failures: If the API key credential is invalid or expired, the node will fail to authenticate.
  • Malformed Project IDs: For Lead or Staff roles, ensure the project_ids string is correctly formatted as comma-separated values without extra spaces or invalid characters.
  • Unsupported Operation or Resource: The node throws errors if an unsupported resource or operation is specified.

To resolve these issues, verify input parameters carefully, check API credentials, and consult API documentation for role-specific requirements.

Links and References

Discussion