Pulse Office Action icon

Pulse Office Action

Office actions from Pulse API

Actions17

Overview

The node provides integration with a Pulse API to manage "Planning" resources, specifically allowing updating of existing planning entries. The "Update Planning" operation modifies details of a specified planning entity such as its name, timezone, organizational unit, working hours per day, and schedule.

This node is useful in scenarios where workforce or project planning data needs to be programmatically updated within an automation workflow. For example, if a company changes the working hours or schedule for a department, this node can update the corresponding planning record automatically based on input data or triggers from other systems.

Practical examples:

  • Automatically adjusting employee shift schedules after a holiday or special event.
  • Updating organizational unit assignments or timezones when teams are reorganized.
  • Modifying daily working hours due to policy changes or operational requirements.

Properties

Name Meaning
Planning ID * The unique identifier of the planning entry to update.
Name * The new name for the planning.
Timezone * The timezone associated with the planning (e.g., "Africa/Nairobi").
Organizational Unit * The organizational unit that the planning belongs to.
Working Hours Per Day Number of working hours per day for the planning (decimal allowed, minimum 0).
Schedule * The detailed schedule in JSON format specifying working periods per day. Format: { "day": ["start1", "end1", "start2", "end2"] }

*Properties marked with * are required.

Output

The node outputs a JSON object representing the updated planning resource as returned by the Pulse API. This typically includes all fields of the planning entity reflecting the new state after the update.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to the Pulse API service via an API key credential configured in n8n.
  • The node depends on the Pulse API helper utilities bundled in the node's codebase to perform authenticated requests.
  • Proper permissions on the API key are necessary to update planning resources.

Troubleshooting

  • Common issues:

    • Invalid or missing Planning ID will cause the update to fail.
    • Incorrect JSON format in the Schedule property may result in API errors.
    • Insufficient API permissions or expired credentials will prevent successful updates.
    • Timezone values must be valid IANA timezone strings; invalid values may cause errors.

  • Error messages:

    • "Unknown operation" error indicates the selected operation is not supported for the resource.
    • API response errors usually include descriptive messages about validation failures or authorization issues.

  • Resolutions:

    • Verify that the Planning ID exists and is correct.
    • Validate the JSON structure of the Schedule before passing it to the node.
    • Ensure the API key credential is correctly set up and has update permissions.
    • Use valid timezone identifiers.

Links and References

  • IANA Time Zone Database — Reference for valid timezone names.
  • Pulse API documentation (not publicly linked here) — Consult your API provider for detailed schema and authentication setup.

Discussion