Zammad icon

Zammad

Consume Zammad REST API

Actions57

Organization → Create

AI-generated

Overview

This node integrates with the Zammad REST API to manage organizations within the Zammad system. Specifically, the 'Create' operation under the 'Organization' resource allows users to create a new organization by specifying required and optional fields, including custom fields. This is useful for automating the addition of organizations in a customer support or ticketing environment, enabling streamlined data entry and management.

Use Case Examples

  1. Automatically create a new organization in Zammad when a new client signs up on your platform.
  2. Add organizations with specific domain assignments and notes for better categorization and management in your support system.

Properties

Name Meaning
Authentication The authentication method to use for API requests, such as Basic Authentication, OAuth2, or Token Authentication.
API The API type to use, either REST API or CTI API.
Name The name of the organization to create. This is a required field.
Additional Fields Optional fields to provide additional details about the organization, such as domain assignment status, domain name, shared status, active status, and notes.
Custom Fields Allows adding custom fields with specific names and values to set additional data on the organization.

Output

JSON

  • id - The unique identifier of the created organization.
  • name - The name of the created 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 - The note associated with the organization.
  • customFields - Any custom fields set on the organization.

Dependencies

  • Requires authentication credentials for Zammad API (Basic Auth, OAuth2, or Token Auth).

Troubleshooting

  • Ensure that the required 'Name' field is provided; missing this will cause the API request to fail.
  • Verify that the authentication credentials are correctly configured and valid to avoid authorization errors.
  • Check the API endpoint and network connectivity if requests fail to reach the Zammad server.
  • If custom fields are used, ensure the field names match those expected by the Zammad instance to prevent errors.

Links

  • Zammad API Documentation - Official documentation for the Zammad REST API, useful for understanding available endpoints and data structures.

Discussion