Zammad icon

Zammad

Consume Zammad REST API

Actions57

Organization → Update

AI-generated

Overview

This node operation updates an existing organization in the Zammad system using the REST API. It allows users to modify the organization's name, optional fields such as domain, active status, and notes, as well as custom fields. This operation is useful for maintaining up-to-date organizational information in a customer support or ticketing system.

Use Case Examples

  1. Updating the name and domain of an organization to reflect a recent rebranding.
  2. Activating or deactivating an organization based on its current status.
  3. Adding or modifying custom fields to store additional organization-specific data.

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 (REST API or CTI API).
Name The new name of the organization to update.
ID The unique identifier of the organization to update.
Additional Fields Optional fields to update for the organization, such as domain assignment status, domain name, shared status, active status, and notes.
Custom Fields Custom fields to set additional values for the organization. Each custom field has a name and a value.

Output

JSON

  • id - The unique identifier of the updated organization.
  • name - The updated name of the organization.
  • domain_assignment - Indicates if the organization's domain assignment is active.
  • domain - The domain of the organization.
  • shared - Indicates if the organization is shared.
  • active - Indicates if the organization is active.
  • note - Notes or comments about the organization.
  • customFields - Custom fields and their values set on the organization.

Dependencies

  • Zammad REST API

Troubleshooting

  • Ensure the organization 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 organizations.
  • Check that required fields like 'name' and 'id' are provided; missing these will cause validation errors.
  • If custom fields are used, ensure the field names are valid and recognized by the Zammad system.

Links

Discussion