Customer.io API
Arcade Unoptimized
Tools that enable LLMs to interact directly with the Customer.io App API
Author:Arcade
Version:
0.2.1Auth:No authentication required
115tools
115require secrets
Customer.io API Toolkit provides a set of tools that enable easy interaction with the Customer.io App API, enhancing marketing automation workflows.
Capabilities:
- Create, manage, and delete segments, collections, and newsletters.
- Fetch detailed delivery and performance metrics for campaigns and transactional messages.
- Manage customer data with CRUD operations on customer attributes and activities.
- Retrieve insights on message performance, including link metrics and suppression statuses.
Secrets:
- Use the
CUSTOMERIO_API_KEYto authenticate API requests, ensuring secure access to your Customer.io resources.
Available tools(115)
115 of 115 tools
| Tool name | Description | Secrets | |
|---|---|---|---|
Retrieve suppression status and reason for an email.
Use this tool to find out if an email address has been suppressed by the email service provider (ESP) and the reasons for its suppression. | 1 | ||
Create a manual segment with name and description.
Use this tool to create an empty manual segment by specifying its name and description. Ideal for organizing contacts or data into new categories.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new data collection in Customerio.
Use this tool to create a new collection in Customerio by either providing direct data or a URL for downloading CSV or JSON data. Ensure the collection does not exceed 10 MB, and individual rows are under 10 KB.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new webhook configuration for reporting.
Use this tool to set up a new webhook configuration within the Customerio service for reporting purposes.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Delete a collection and its contents.
Use this tool to remove a collection and all its contents from the system. Ensure the collection is not referenced in active campaign messages or broadcasts to avoid disrupting communication. | 1 | ||
Delete a specified manual segment by ID.
Use this tool to delete a specific manual segment in Customerio by providing the segment ID. It's useful for removing outdated or unwanted segments. | 1 | ||
Delete an individual newsletter and its associated data.
Use this tool to delete a specific newsletter, including its content, settings, and metrics. It will be removed from segments, and its templates will be erased from the Message Library. Additionally, any undelivered in-app messages will be canceled. | 1 | ||
Delete a reporting webhook's configuration.
Use this tool to remove the configuration of a specific reporting webhook by its ID. Call this when a webhook is no longer needed and should be deleted from the setup. | 1 | ||
Retrieve a temporary signed link to download an export.
Use this tool to get a signed link for downloading an export from Customerio. The link is only valid for 15 minutes, so it should be used promptly. | 1 | ||
Export customer data based on specified filters.
Use this tool to export customer data by providing filters and attributes. It returns metadata useful for initiating the data download process.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Initiates export of delivery data for newsletters and campaigns.
This tool is used to start an export of delivery data for newsletters, campaigns, or actions based on given filters. Data spans a specified time range, with default and maximum limits. Use it to obtain delivery insights over a specified timeframe.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Retrieve a list of message deliveries and their metrics.
This tool retrieves a list of message deliveries, including metrics, within a specified time range in your workspace. Use it to analyze message performance over the most recent six months or a defined period. If no specific time range is provided, it defaults to the last six months. | 1 | ||
Filter and search for people in your workspace.
Use this tool to filter people by segment ID and attribute values using complex filters such as `and`, `or`, and `not`. The tool returns arrays of `identifiers` with detailed information and `ids` with only ID values. Suitable for retrieving up to 1000 people per request.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Identify campaigns and newsletters using a segment.
This tool identifies which campaigns and newsletters are utilizing a specified segment in Customerio. It should be called when you need to determine the dependencies of a segment within your marketing strategies. | 1 | ||
Retrieve email addresses suppressed for specific reasons.
Use this tool to identify and retrieve email addresses suppressed by the Email Service Provider for reasons such as bounces, blocks, spam reports, or invalid addresses. Supports pagination for large datasets. | 1 | ||
Find objects in your workspace using filter conditions.
This tool is used to find and return a list of object IDs based on specified filter conditions in your Customerio workspace. It allows paging through results and setting limits on the number of objects returned. Useful for locating, creating, or modifying objects based on specific criteria.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Retrieve IP addresses to allowlist for secure access.
Use this tool to obtain a list of IP addresses that should be allowlisted when configuring firewall settings or using a custom SMTP provider's IP management to deny unknown IPs. This is applicable to all message types and webhooks, except push notifications. | 1 | ||
Retrieve a list of all segments for your account.
Call this tool to get a list of all segments associated with your Customerio account. Use it to fetch and review segment data. | 1 | ||
Retrieve an archived copy of a message delivery.
Fetches the archived version of a delivery from Customerio, providing details like the message body, recipient, and associated metrics. Limited to 100 requests per day. | 1 | ||
Retrieve details of a specific broadcast action.
Call this tool to obtain detailed information about a specific action within a broadcast by providing the broadcast and action IDs. | 1 | ||
Retrieve link click metrics for a specific broadcast action.
This tool retrieves link click metrics for an individual broadcast action. It provides data for a maximum of 45 days, unless specified otherwise. Use appropriate period and step parameters for custom data ranges. | 1 | ||
Retrieve metrics for a broadcast action over time steps.
Get metrics for an individual broadcast action, both in total and divided by time steps like days or weeks, over a specified period. | 1 | ||
Retrieve actions from a specific broadcast.
Use this tool to get detailed actions that occur as part of a specific broadcast by providing the broadcast ID. | 1 | ||
Retrieve details of broadcast validation errors.
This tool helps identify and understand validation errors in broadcast campaigns, focusing on issues within the broadcast audience and associated elements. Use it to diagnose and resolve broadcast errors. | 1 | ||
Retrieve metrics for link clicks in a broadcast.
This tool returns metrics for link clicks within a specified broadcast, providing both total counts and series data over defined periods such as days or weeks. Useful for analyzing broadcast performance. | 1 |
Page 1 of 5(25 of 115)
Get Building
Last updated on