Zammad icon

Zammad

Consume Zammad REST API

Actions57

Online Notification → Update

AI-generated

Overview

This node operation updates an existing online notification in the Zammad system using the REST API. It allows users to modify various optional fields of the online notification, such as its seen status, associated object IDs, type lookup ID, and user ID. This operation is useful for scenarios where you need to programmatically update the status or details of notifications within Zammad, for example, marking notifications as seen or associating them with different objects or users.

Use Case Examples

  1. Mark an online notification as seen after a user has viewed it.
  2. Update the user ID associated with a specific online notification.
  3. Change the object or type lookup IDs related to an online notification for better categorization.

Properties

Name Meaning
Authentication The authentication method to use for the API request (Basic, OAuth2, or Token Authentication).
API The API to use for the request, either REST API or CTI API.
Online Notification ID The unique identifier of the online notification to update.
Additional Fields Optional fields to update on the online notification, such as seen status, object ID, object lookup ID, type lookup ID, and user ID.

Output

JSON

  • id - The unique identifier of the updated online notification.
  • seen - The seen status of the online notification.
  • o_id - The object ID associated with the online notification.
  • object_lookup_id - The object lookup ID associated with the online notification.
  • type_lookup_id - The type lookup ID associated with the online notification.
  • user_id - The user ID associated with the online notification.

Dependencies

  • Zammad REST API

Troubleshooting

  • Ensure the Online Notification ID is valid and exists in the system; otherwise, the update will fail.
  • Verify that the authentication credentials (Basic, OAuth2, or Token) are correctly configured and have the necessary permissions to update online notifications.
  • Check that the optional fields provided are of the correct type (e.g., boolean for 'seen', numbers for IDs) to avoid validation errors from the API.

Links

Discussion