Pulse Office Action icon

Pulse Office Action

Office actions from Pulse API

Overview

The node provides integration with the Pulse API to manage various office-related resources, including announcements. Specifically, the Update Announcement operation allows users to modify existing announcements by specifying the announcement ID and the fields they want to update. This is useful in scenarios where announcements need to be corrected, updated with new information, or rescheduled.

Practical examples include:

  • Updating the title or content of an announcement after initial publication.
  • Changing the publishing date to delay or advance when the announcement becomes visible.
  • Modifying the organizational units targeted by the announcement to adjust its audience.

Properties

Name Meaning
Announcement ID * The unique identifier of the announcement to update.
Fields to Update A collection of fields that can be updated in the announcement:
- Title The new title for the announcement.
- Content (Markdown) The updated content of the announcement, formatted in Markdown.
- Publishing Date The new date when the announcement will be published; must not be before the current date.
- Organizational Units Comma-separated list of organizational units (e.g., departments) that the announcement targets.

Output

The output of the node is a JSON object representing the updated announcement as returned by the Pulse API. It typically includes all relevant announcement details such as ID, title, content, publishing date, and organizational units after the update.

No binary data output is associated with this operation.

Dependencies

  • Requires 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 authenticated requests.
  • Proper permissions on the Pulse API are necessary to update announcements.

Troubleshooting

  • Common Issues:

    • Providing an invalid or non-existent Announcement ID will likely result in an error from the API indicating the resource was not found.
    • Setting a publishing date earlier than the current date may cause validation errors.
    • Incorrect formatting of organizational units (e.g., missing commas) might lead to unexpected behavior or API rejection.
  • Error Messages:

    • "Unknown operation" errors indicate that the selected operation is not supported for the resource; ensure "updateAnnouncement" is chosen under the "Announcement" resource.
    • API authentication errors suggest issues with the configured API key or credentials.
    • Validation errors from the API regarding field formats should be resolved by correcting input values according to the property descriptions.

Links and References

Discussion