Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows you to replace the managers associated with a specific custom field value within an account. It is useful in scenarios where you need to update or reassign managerial responsibilities linked to particular custom field entries, such as changing the team leads responsible for a project or department identified by a custom field.

Practical examples include:

  • Updating the list of managers for a custom field representing a project code when project leadership changes.
  • Replacing managers assigned to a custom field value that tracks client accounts or internal resources.

Properties

Name Meaning
Account Id Identifier of the account where the custom field exists.
Custom Field Id Identifier of the custom field whose value's managers are to be replaced.
Custom Field Value Id Identifier of the specific value within the custom field for which managers will be replaced.
Body JSON object containing the details of the new managers to assign. This should be a valid JSON structure specifying the replacement data.

Output

The node outputs JSON data reflecting the result of the manager replacement operation. The exact structure depends on the API response but typically includes confirmation of the update and details about the new manager assignments.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authentication with the external service managing the custom fields.
  • The node expects the base URL of the API to be configured in the credentials.
  • The request content type is application/json.

Troubleshooting

  • Invalid or missing identifiers: Ensure that the Account Id, Custom Field Id, and Custom Field Value Id are correct and correspond to existing entities in the system.
  • Malformed JSON in Body: The Body property must contain valid JSON. Invalid JSON will cause parsing errors.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to modify custom field managers.
  • API connectivity issues: Check network connectivity and the correctness of the base URL configured in credentials.

Common error messages may include:

  • "Unauthorized" or "Authentication failed": Indicates issues with API credentials.
  • "Not Found": One of the provided IDs does not exist.
  • "Bad Request": Usually due to invalid JSON body or missing required fields.

Resolving these involves verifying input values, ensuring proper JSON formatting, and confirming credential validity.

Links and References

  • Refer to the external API documentation for managing custom fields and their values.
  • JSON validation tools can help ensure the Body property contains valid JSON before execution.

Discussion