Kakiyo

Interact with the Kakiyo API

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 - Create operation, it allows users to create a new campaign by specifying essential details like the campaign name, associated product, prompt, agent, qualification thresholds, and custom variables.

Typical use cases include automating campaign creation workflows in marketing automation, lead generation, or sales outreach platforms where campaigns need to be programmatically created and configured based on dynamic inputs.

For example, a user might automate the creation of a campaign targeting a specific product launch, linking it to a predefined prompt (message template) and an agent responsible for outreach, while setting qualification criteria to filter leads automatically.

Properties

Name Meaning
Name The name/title of the campaign to be created.
Product ID Identifier of the product associated with this campaign.
Prompt ID Identifier of the prompt (message template) used in this campaign.
Agent ID Identifier of the agent responsible for managing or executing the campaign.
Qualification Automatic Numeric threshold (0-100) for automatic qualification of prospects within the campaign.
Qualification Verification Numeric threshold (0-100) for verification qualification of prospects within the campaign.
Variables A collection of key-value pairs representing custom variables to be included in the campaign.

The Variables property supports multiple entries, each requiring a variable name and its corresponding value. These variables can be used to customize or parameterize the campaign dynamically.

Output

The node outputs JSON data representing the response from the Kakiyo API after creating the campaign. This typically includes details of the newly created campaign such as its unique ID, configuration, status, and any other metadata returned by the API.

The output is structured as an array of JSON objects, each corresponding to an input item processed by the node. There is no binary data output for this operation.

Dependencies

  • Requires an active connection to the Kakiyo API.
  • Needs an API authentication token or API key credential configured in n8n under the node's credentials settings.
  • The base URL for the Kakiyo API must be set in the credentials configuration.
  • The node uses standard HTTP methods (POST) to communicate with the API endpoint /campaigns.

Troubleshooting

  • Missing Required Fields: If required properties like Name, Product ID, Prompt ID, or Agent ID are not provided, the API will likely return an error. Ensure all mandatory fields are filled.
  • Invalid Qualification Thresholds: Qualification values should be between 0 and 100. Values outside this range may cause validation errors.
  • API Authentication Errors: If the API key or token is invalid or missing, requests will fail with authentication errors. Verify that credentials are correctly configured.
  • Network Issues: Connectivity problems or incorrect base URL settings can cause request failures. Confirm network access and correct API endpoint configuration.
  • Variable Formatting: Variables must be provided as an array of objects with name and value. Incorrect formatting may result in API rejection.

If the node throws errors, check the error message returned in the output JSON for clues, and verify the input parameters and credentials accordingly.

Links and References

This summary focuses exclusively on the Campaign resource's Create operation as requested.

Discussion