Zammad icon

Zammad

Consume Zammad REST API

Actions57

State → Update

AI-generated

Overview

This node operation updates an existing state in the Zammad system using the REST API. It allows users to modify properties of a ticket state such as its name, state type ID, and various optional fields like next state ID, escalation behavior, active status, default creation and follow-up flags, and notes. This operation is useful for managing and customizing ticket states in a customer support or helpdesk workflow.

Use Case Examples

  1. Updating the name and state type of a ticket state to reflect a new workflow stage.
  2. Setting a state as active and default for ticket creation to streamline ticket handling.
  3. Adding a note to a state to provide additional context for support agents.

Properties

Name Meaning
Authentication The authentication method to use for API requests (Basic, OAuth2, or Token Authentication).
API The API to use for the operation, either REST API or CTI API.
Name The name of the state to update.
State Type ID The state type ID of the state to update.
State ID The unique identifier of the state to update.
Additional Fields Optional additional fields to update on the state, such as next state ID, ignore escalation flag, active status, default create flag, default follow-up flag, and note.

Output

JSON

  • id - The unique identifier of the updated state.
  • name - The name of the updated state.
  • state_type_id - The state type ID of the updated state.
  • next_state_id - The ID of the next state, if set.
  • ignore_escalation - Indicates if escalation is ignored for this state.
  • active - Indicates if the state is active.
  • default_create - Indicates if the state is the default for ticket creation.
  • default_follow_up - Indicates if the state is the default for follow-up.
  • note - A note or comment associated with the state.

Dependencies

  • Zammad REST API

Troubleshooting

  • Ensure the state ID provided exists; otherwise, the update will fail with a not found error.
  • Verify that the authentication credentials are correct and have sufficient permissions to update states.
  • Check that required fields like 'name' and 'state_type_id' are provided and valid.
  • If optional fields are used, ensure their values are of the correct type (e.g., boolean for flags, number for IDs).
  • Handle API rate limits or network issues that might cause request failures.

Links

Discussion