Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node interacts with the Keitaro API to perform various operations on different resources, including groups. Specifically, for the 'Группа' (Group) resource and the 'Обновить' (Update) operation, the node updates an existing group in Keitaro by sending the provided group ID and JSON-formatted group data to the API. This is useful for automating updates to group configurations or attributes within Keitaro campaigns.

Use Case Examples

  1. Updating a group with new settings or attributes by providing the group ID and updated JSON data.
  2. Automating group management in Keitaro by integrating with workflows that modify group details based on external triggers.

Properties

Name Meaning
ID Группы The unique identifier of the group to update. Required for update operations.
Данные Группы The JSON-formatted data representing the group's updated attributes. Required for create and update operations.

Output

JSON

  • request
    • url - The URL of the API request made to Keitaro.
    • method - The HTTP method used for the API request.
    • headers - Headers sent with the API request, with sensitive data like API keys masked.
  • resource - The resource type involved in the operation, e.g., 'group'.
  • operation - The operation performed, e.g., 'update'.
  • success - Indicates if the operation was successful (true for update).
  • data - The data returned from the Keitaro API after the update operation.

Dependencies

  • Requires an API key credential for Keitaro API access and the domain URL of the Keitaro instance.

Troubleshooting

  • Ensure the 'ID Группы' is provided and valid for update operations; missing or invalid IDs will cause errors.
  • The 'Данные Группы' must be valid JSON and contain the necessary fields expected by the Keitaro API; invalid JSON or missing required fields will cause API errors.
  • Verify that the API key and domain are correctly set in the credentials; missing or incorrect credentials will prevent successful API calls.
  • Check the API response status codes and messages for specific errors returned by Keitaro, such as permission issues or invalid data formats.

Discussion