Kakiyo

Interact with the Kakiyo API
Join our community

Actions19

Overview

This node integrates with the Kakiyo API to manage marketing campaigns and related entities such as agents, products, prompts, and prospects. Specifically, for the Campaign - Pause operation, it allows users to pause an active campaign by specifying its unique campaign ID. This is useful in scenarios where a campaign needs to be temporarily halted without deleting or permanently stopping it, such as during a strategic pause, resource reallocation, or while making adjustments.

Practical examples:

  • Temporarily pausing a campaign that is underperforming to analyze and optimize its settings.
  • Pausing a campaign due to external factors like holidays or market conditions.
  • Coordinating campaign timing by pausing and resuming campaigns programmatically.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to pause. This is required to specify which campaign should be paused.

Output

The node outputs JSON data representing the response from the Kakiyo API after attempting to pause the specified campaign. The structure typically includes confirmation of the pause action or details about the campaign's updated status.

  • The json output field contains the API response parsed into JSON format.
  • No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Kakiyo API.
  • The base URL for the Kakiyo API must be configured in the node credentials.
  • Network connectivity to the Kakiyo API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID: The API will reject requests without a valid campaign identifier.
    • Authentication failures: Ensure the API key credential is correctly set up and has sufficient permissions.
    • Network errors or timeouts: Verify network access to the Kakiyo API service.

  • Error messages:

    • Errors returned from the API (e.g., "Campaign not found" or "Unauthorized") will be included in the node output if "Continue On Fail" is enabled.
    • To resolve, verify the campaign ID exists and the API credentials are correct.

Links and References

Discussion