Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

External Teams → Update External Teams

AI-generated

Overview

This node updates an existing external team in an account management system. It is useful when you need to modify details of a team that exists outside your core system, such as updating team names, members, or other metadata associated with the external team.

Typical use cases include:

  • Synchronizing team information from an external HR or collaboration platform.
  • Correcting or enriching team data without recreating the team.
  • Automating updates to external teams based on changes in your internal systems.

For example, if a team's name or description changes in your internal database, this node can push those updates to the external system automatically.

Properties

Name Meaning
Account Id Identifier of the account where the external team exists. This is required to specify which account's team should be updated.
Body JSON object representing the external team data to update. Should exclude autogenerated fields. This allows specifying any updatable properties of the external team.

Output

The node outputs the response from the external API after attempting to update the external team. The output is structured as JSON and typically contains the updated external team object or confirmation of the update operation.

If the external API supports binary data in responses (not indicated here), it would be included accordingly, but this node primarily deals with JSON data.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external service managing the teams.
  • The base URL for the API is expected to be provided via credentials or environment configuration.
  • Uses an OpenAPI-based client internally to handle request construction and execution.

Troubleshooting

  • Invalid Account Id: If the account identifier is incorrect or missing, the API will likely return an error indicating the account was not found. Verify the account ID before running the node.
  • Malformed JSON in Body: The "Body" property expects valid JSON. Errors parsing this input will cause the node to fail. Ensure the JSON syntax is correct and excludes autogenerated fields.
  • Authentication Errors: Missing or invalid API credentials will result in authorization failures. Confirm that the API key or token is correctly set up in n8n credentials.
  • API Endpoint Issues: Network errors or incorrect base URLs can cause request failures. Check connectivity and configuration of the API endpoint.

Links and References

  • Refer to the external team's API documentation for detailed schema of the team object and supported update operations.
  • Consult n8n documentation on how to configure API credentials and use JSON input properties effectively.

Discussion