Customer.io API
Tools that enable LLMs to interact directly with the Customer.io App API
1.0.0Customer.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)
| 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 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
CustomerioApi.CheckEmailSuppression
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_to_check_suppression | string | Required | The email address to check for suppression status and reasons. |
Requirements
Output
json— Response from the API endpoint 'getSuppression'.CustomerioApi.CreateManualSegment
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createManSegment'.CustomerioApi.CreateNewCollection
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'addCollection'.CustomerioApi.CreateWebhook
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createWebhook'.CustomerioApi.DeleteCollection
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collection_id | integer | Required | The unique identifier for the collection to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteCollection'.CustomerioApi.DeleteManualSegment
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_identifier | integer | Required | The ID of the segment to delete, found under 'Usage' in the Segment page on the dashboard or via the App API. |
Requirements
Output
json— Response from the API endpoint 'deleteManSegment'.CustomerioApi.DeleteNewsletter
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The unique identifier of the newsletter you want to delete. |
Requirements
Output
json— Response from the API endpoint 'deletetNewsletters'.CustomerioApi.DeleteReportingWebhook
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_identifier | integer | Required | The unique identifier for the reporting webhook to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteWebhook'.CustomerioApi.DownloadExportSignedLink
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
export_identifier | integer | Required | The unique ID of the export you want to access and download. Must be an integer. |
Requirements
Output
json— Response from the API endpoint 'downloadExport'.CustomerioApi.ExportCustomerData
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'exportPeopleData'.CustomerioApi.ExportDeliveryData
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'exportDeliveriesData'.CustomerioApi.FetchMessageDeliveries
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
beginning_timestamp | integer | Optional | The beginning timestamp in Unix format for your query. Returns deliveries created after this time. |
desired_metrics | string | Optional | Specifies the metrics to retrieve. Options include: attempted, sent, delivered, opened, clicked, converted, bounced, spammed, unsubscribed, dropped, failed, undeliverable. |
ending_timestamp_for_query | integer | Optional | The ending timestamp for your query. If not specified, it defaults to the current time. |
filter_by_action_id | integer | Optional | Specify the action ID to filter the message deliveries. This narrows the results to messages associated with the given action. |
filter_by_campaign_id | integer | Optional | The ID of the campaign to filter message deliveries. Use this to retrieve data for a specific campaign only. |
filter_by_newsletter_id | integer | Optional | An integer representing the ID of the newsletter to filter deliveries for. |
item_type_for_metrics | string | Optional | Specify the item type to return metrics for, such as 'email', 'webhook', 'twilio', 'slack', 'push', or 'in_app'. Leave empty for all types. |
page_token | string | Optional | The token to fetch the specified page of delivery results. |
results_per_page_limit | integer | Optional | Specifies the maximum number of results to retrieve per page. |
return_drafts_only | boolean | Optional | Set to true to return drafts instead of active or sent messages. |
Requirements
Output
json— Response from the API endpoint 'listMessages'.CustomerioApi.FilterPeopleInWorkspace
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
page_start_token | string | Optional | The token for the page of results to return. Use the 'next' property from responses as this value to access subsequent pages. Only used when mode is 'execute'. |
results_per_page_limit | integer | Optional | Specify the maximum number of people to retrieve per page. Limited to 1000. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getPeopleFilter'.CustomerioApi.FindSegmentDependencies
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_identifier | integer | Required | The ID for a segment, found on its dashboard page or via the App API. |
Requirements
Output
json— Response from the API endpoint 'getSegmentDependencies'.CustomerioApi.FindSuppressedEmailAddresses
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
suppression_reason | string | Required | Specify the reason for email address suppression, such as bounces or spam reports. |
max_results_per_page | integer | Optional | The maximum number of suppression records to retrieve per page, up to 1000. |
skip_records | integer | Optional | The number of records to skip before retrieving results. |
Requirements
Output
json— Response from the API endpoint 'getSuppressionByType'.CustomerioApi.FindWorkspaceObjects
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
page_start_token | string | Optional | Token for the page of results to return. Use the `next` property from a prior response to continue paging. Only used when mode is 'execute'. |
maximum_results_per_page | integer | Optional | The maximum number of results to retrieve per page. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getObjectsFilter'.CustomerioApi.GetAllowlistIps
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.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getCioAllowlist'.CustomerioApi.GetAllSegments
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.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listSegments'.CustomerioApi.GetArchivedMessage
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
message_id | string | Required | The unique identifier for the message to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'getArchivedMessage'.CustomerioApi.GetBroadcastActionInfo
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_id | integer | Required | The ID of the action to look up or act on within a broadcast. |
broadcast_identifier | integer | Required | The numeric identifier of the broadcast to retrieve action details from. |
Requirements
Output
json— Response from the API endpoint 'getBroadcastAction'.CustomerioApi.GetBroadcastActionLinkMetrics
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_action_id | integer | Required | The ID of the action you want to look up or act on. |
broadcast_identifier | integer | Required | The unique identifier for the broadcast to retrieve metrics for. It should be an integer value. |
item_type | string | Optional | Specifies the type of item to return metrics for; options include email, webhook, twilio, slack, push, and in_app. Leave empty for all types. |
number_of_periods_to_return | integer | Optional | The number of time periods to return metrics for. Defaults to the maximum, or 12 if in months. Max: 24 hours, 45 days, 12 weeks, 121 months. |
time_period_unit | string | Optional | The unit of time for the report. Acceptable values are 'hours', 'days', 'weeks', or 'months'. |
Requirements
Output
json— Response from the API endpoint 'broadcastActionLinks'.CustomerioApi.GetBroadcastActionMetrics
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The ID of the broadcast you wish to retrieve metrics for. |
lookup_action_id | integer | Required | The ID of the action you want to look up or act on. Provide an integer value. |
metrics_item_type | string | Optional | Specifies the type of item (e.g., email, webhook) to return metrics for. If not provided, metrics for all types are returned. |
period_steps | integer | Optional | Specify the number of time periods to return metrics for. Defaults to the maximum allowed (24 hours, 45 days, 12 weeks, or 121 months) or `12` if the period is in months. |
time_unit_for_report | string | Optional | The unit of time for the report, such as hours, days, weeks, or months. |
Requirements
Output
json— Response from the API endpoint 'broadcastActionMetrics'.CustomerioApi.GetBroadcastActions
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The unique identifier of the broadcast to retrieve its actions. |
Requirements
Output
json— Response from the API endpoint 'broadcastActions'.CustomerioApi.GetBroadcastErrors
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_id | integer | Required | The ID of the broadcast to retrieve error information for. Use this to specify which broadcast's errors you want to investigate. |
campaign_trigger_id | integer | Required | The ID of the campaign trigger to return information for. Use this to focus on specific trigger details. |
page_start_token | string | Optional | Token to specify which page of results to return. Use the `next` value from responses to navigate pages. |
results_per_page | integer | Optional | The maximum number of results to retrieve per page. |
Requirements
Output
json— Response from the API endpoint 'broadcastErrors'.CustomerioApi.GetBroadcastLinkMetrics
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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The numeric identifier of the broadcast for which link metrics are needed. |
period_steps | integer | Optional | Specify the number of time periods to return. Defaults to the maximum or 12 if the period is 'months'. Max: 24 hours, 45 days, 12 weeks, or 121 months. |
report_period | string | Optional | Defines the unit of time for the report. Options are 'hours', 'days', 'weeks', or 'months'. |
return_unique_customer_results | boolean | Optional | Set to true to return only unique customer results, ensuring each customer is counted once regardless of clicks. |
Requirements
Output
json— Response from the API endpoint 'broadcastLinks'.CustomerioApi.GetBroadcastMessageInfo
Retrieve details about broadcast message deliveries. This tool returns information about message deliveries from an API-triggered broadcast. Use it to get insights on individual deliveries within a specific time range by providing `start_ts` and `end_ts`. If not specified, data for one month post-trigger is returned. The information reflects when the deliveries were created, with a possible delay to actual send time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The ID used to identify the specific broadcast to retrieve information about. |
beginning_timestamp | integer | Optional | The start timestamp for the query, defining the beginning of the time range for message retrieval. |
broadcast_state | string | Optional | Specifies the state of a broadcast message. Options are: 'failed', 'sent', 'drafted', or 'attempted'. |
ending_timestamp | integer | Optional | The endpoint of the time range for the query. It must be an integer representing a timestamp. |
item_type | string | Optional | Specify the type of item to return metrics for (e.g., email, webhook). Leave empty for all types. |
maximum_results_per_page | integer | Optional | Specify the maximum number of message deliveries to retrieve per page. Adjust to control the pagination size for results. |
metric_type | string | Optional | Select the metric(s) to be returned. Options include: 'attempted', 'sent', 'delivered', 'opened', 'clicked', 'converted', 'bounced', 'spammed', 'unsubscribed', 'dropped', 'failed', 'undeliverable'. |
pagination_start_token | string | Optional | Token for the page of results to return. Use the 'next' property from responses for this value to get the next page. |
Requirements
Output
json— Response from the API endpoint 'broadcastMessages'.CustomerioApi.GetBroadcastMetadata
Retrieve metadata for a specific broadcast. Use this tool to get detailed metadata for an individual broadcast based on its unique identifier. Useful for tracking and analyzing individual broadcast details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The unique identifier for a specific broadcast. Use this to retrieve the corresponding metadata. |
Requirements
Output
json— Response from the API endpoint 'getBroadcast'.CustomerioApi.GetBroadcastMetrics
Retrieve metrics for a specific broadcast over defined time steps. This tool retrieves a list of performance metrics for an individual broadcast, broken down into specified time intervals (steps) such as days or weeks. It is useful for analyzing broadcast performance trends. The metrics are returned from the oldest to the newest period.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The unique integer identifier for a specific broadcast. |
metric_type | string | Optional | Specify the type of item to return metrics for. Options include 'email', 'webhook', 'twilio', 'slack', 'push', and 'in_app'. Leave empty to get metrics for all types. |
number_of_time_periods | integer | Optional | The number of time periods to return metrics for. Follow the specific period limits: 24 for hours, 45 for days, 12 for weeks, or 121 for months. Defaults if not specified: to maximum available or 12 for monthly periods. Days start at 00:00 EST, weeks at 00:00 EST on Sunday, and months at 00:00 EST on the 1st. |
time_period_unit | string | Optional | Specifies the unit of time for the report, such as hours, days, weeks, or months. |
Requirements
Output
json— Response from the API endpoint 'broadcastMetrics'.CustomerioApi.GetBroadcastStatus
Retrieve the status of a broadcast using its trigger ID. Use this tool to get the current status of a broadcast after it has been triggered. Requires the `broadcast_id` and `trigger_id` to fetch the specific status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The unique ID of the broadcast to retrieve information about. This should be an integer. |
campaign_trigger_id | integer | Required | The ID of the specific campaign trigger whose status you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'broadcastStatus'.CustomerioApi.GetBroadcastTranslationInfo
Retrieve translation info for a broadcast message. Use this tool to get details about a specific translation of a message within a broadcast by providing the `action_id`. Useful for checking how a message is translated into a specific language.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_id | integer | Required | The identifier for the action you want to lookup or act on. Used to retrieve specific translation details. |
broadcast_identifier | integer | Required | The unique identifier for a broadcast. Integer type is expected. |
language_tag | string | Required | The language tag for the translation. Use an empty string for the default language. |
Requirements
Output
json— Response from the API endpoint 'getBroadcastActionLanguage'.CustomerioApi.GetBroadcastTriggers
Retrieve triggers for a specific broadcast. Use this tool to get a list of triggers associated with a particular broadcast in the Customerio service. Useful for understanding the actions set for a broadcast.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
broadcast_identifier | integer | Required | The identifier of a broadcast to retrieve its triggers. Must be an integer. |
Requirements
Output
json— Response from the API endpoint 'listBroadcastTriggers'.CustomerioApi.GetCampaignActionInfo
Retrieve details for a specific action in a campaign. Use this tool to get detailed information about a specific action within a marketing campaign. It should be called when you need to understand the specifics of campaign actions such as type, status, or execution details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_id | integer | Required | The identifier for the campaign action you want to look up or act on. Provide the integer ID of the action. |
campaign_identifier | integer | Required | The unique ID of the campaign for retrieving specific action information. |
Requirements
Output
json— Response from the API endpoint 'getCampaignAction'.CustomerioApi.GetCampaignActionLinkMetrics
Retrieve link click metrics for a specific campaign action. This tool retrieves link click metrics for an individual action within a specific campaign. It provides click data for up to 45 days unless specified otherwise and requires at least two steps for any period. Use this tool to analyze link engagement in marketing campaigns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_identifier | integer | Required | The identifier of the action to lookup or perform an operation on in the campaign. It is expected to be an integer. |
campaign_id | integer | Required | The unique ID of the campaign to retrieve metrics for. Ensure this is a valid integer. |
metric_item_type | string | Optional | Specify the type of item to return metrics for. Acceptable values are 'email', 'webhook', 'twilio', 'slack', 'push', 'in_app'. Leave empty for metrics of all types. |
number_of_periods_to_return | integer | Optional | Number of periods to return metrics for. Defaults to max available or 12 if in months. Max: 24 hours, 45 days, 12 weeks, 121 months. |
report_time_unit | string | Optional | The unit of time for the report. Options: hours, days, weeks, or months. |
Requirements
Output
json— Response from the API endpoint 'campaignActionLinks'.CustomerioApi.GetCampaignActionMetrics
Retrieve metrics for a specific campaign action. Fetch detailed metrics for an individual action within a campaign. Utilizes version 2, allowing for flexible time ranges and resolution-based metrics. Essential for tracking the performance of campaign actions over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_identifier | integer | Required | The ID of the specific action to retrieve metrics for within a campaign. |
campaign_id | integer | Required | The integer ID of the campaign to retrieve metrics for. |
metrics_api_version | string | Required | Specify the version of the metrics API to use. Recommended to use version '2'. |
item_type_for_metrics | string | Optional | Specify the type of item to return metrics for, such as 'email', 'webhook', 'twilio', etc. Leaving it empty returns metrics for all types. |
metrics_end_timestamp | integer | Optional | The Unix timestamp marking the end of the metrics period. Applicable only for Version 2 and limited to 10 years from the start timestamp. |
metrics_resolution | string | Optional | Specifies the increment for metrics in version 2. Options are hourly, daily, weekly, or monthly. |
metrics_start_timestamp | integer | Optional | Unix timestamp for the start of metrics (Version 2 only). |
number_of_steps | integer | Optional | For Version 1 only. Specifies the number of time periods to return. Defaults to the maximum, or `12` if in months. Maximums are 24 hours, 45 days, 12 weeks, or 120 months. |
timezone | string | Optional | The time zone in region format for the metrics. Default is EST if not specified. |
version_1_time_unit | string | Optional | Specifies the time unit for the report in Version 1 (e.g., hours, days, weeks, months). |
Requirements
Output
json— Response from the API endpoint 'campaignActionMetrics'.CustomerioApi.GetCampaignJourneyMetrics
Retrieve journey metrics for a specific campaign. This tool retrieves a list of journey metrics for a specified campaign. It provides insights into how many people triggered the campaign and other related metrics within a specified time period and resolution. Useful for campaign performance analysis.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | integer | Required | The ID of the campaign to return journey metrics for. |
end_timestamp | integer | Required | The Unix timestamp marking the end of the journey metrics report period. |
metrics_resolution | string | Required | Determines the increment for metrics reporting: hourly, daily, weekly, or monthly. |
start_timestamp | integer | Required | The UNIX timestamp marking the start of the journey metrics report period. |
Requirements
Output
json— Response from the API endpoint 'campaignJourneyMetrics'.CustomerioApi.GetCampaignLinkMetrics
Get link click metrics for a campaign over specified periods. This tool fetches metrics for link clicks within a specified campaign, providing both total and period-specific data (like days or weeks). It's useful for analyzing campaign performance over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_identifier | integer | Required | The unique identifier for the campaign you want metrics for. Use this ID to specify the target campaign. |
count_unique_customers | boolean | Optional | Set to true to only include unique customer results. Set to false to count all clicks. |
number_of_periods | integer | Optional | The number of periods to return metrics for. Defaults to the maximum available, or 12 if the period is in months. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. |
report_time_unit | string | Optional | The unit of time for the report. Options are: 'hours', 'days', 'weeks', 'months'. |
Requirements
Output
json— Response from the API endpoint 'campaignLinkMetrics'.CustomerioApi.GetCampaignList
Retrieve a list of marketing campaigns. Use this tool to get a list of your marketing campaigns and their associated metadata. Ideal for reviewing, auditing, or managing your email campaigns.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listCampaigns'.CustomerioApi.GetCampaignMessages
Retrieve message deliveries from a campaign. Fetch information on individual message deliveries from a specific campaign over a specified time range. Use parameters like `start_ts` and `end_ts` to refine the data to a specific period.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | integer | Required | The ID of the campaign to fetch message deliveries from. |
beginning_timestamp | integer | Optional | The starting timestamp for the query to filter messages from a specific time. |
end_timestamp | integer | Optional | The ending timestamp for your query to specify the end of the time range for retrieving message deliveries. |
message_type | string | Optional | Specify the type of item for metrics (e.g., email, webhook, slack, etc.). Defaults to all types if empty. |
metrics_to_return | string | Optional | Specify the metrics you want to retrieve, such as 'sent', 'opened', or 'clicked'. |
pagination_token | string | Optional | Token indicating the starting point for the page of results to return. Use the `next` property from previous responses. |
results_per_page | integer | Optional | Specify the maximum number of results to retrieve per page. It determines the number of message deliveries returned in a single API response. |
return_drafts | boolean | Optional | Set to true to return drafts rather than active/sent messages. |
Requirements
Output
json— Response from the API endpoint 'getCampaignMessages'.CustomerioApi.GetCampaignMetadata
Retrieve metadata for a specific campaign. Use this tool to get detailed metadata about an individual campaign by specifying the campaign ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | integer | Required | The ID of the campaign for which metadata is requested. Provide a valid integer. |
Requirements
Output
json— Response from the API endpoint 'getCampaigns'.CustomerioApi.GetCampaignMetrics
Fetch metrics for an individual campaign. Use this tool to retrieve a list of metrics for a specific campaign. It supports flexible time-based metrics by utilizing parameters like resolution, time zone, start, and end times. The recommended version 2 provides greater flexibility with these options. This tool is ideal for analyzing campaign performance over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | integer | Required | The unique ID of the campaign to retrieve metrics for. |
metrics_api_version | string | Required | Specify the version of the metrics API to use. Recommended value is '2'. |
end_time_unix | integer | Optional | Unix timestamp marking the end of the metrics period. Use only with version 2. Limited to 10 years from the start parameter. |
metrics_item_type | string | Optional | Specify the type of item for metrics: email, webhook, twilio, slack, push, in_app. Leave empty for all types. |
metrics_start_timestamp | integer | Optional | Unix timestamp marking the start of the metrics period for version 2. |
number_of_steps | integer | Optional | (Version 1 only) The number of periods to return, with defaults and maximum limits based on the period unit (e.g., hours, days). |
resolution | string | Optional | Determines increment for metrics—hourly, daily, weekly, or monthly. Only for Version 2. |
timezone_for_metrics | string | Optional | For version 2 only. Specify the time zone for the metrics requested. Defaults to EST if not provided. Use the region format. |
version_1_time_unit | string | Optional | For Version 1 only, specify the time unit for the report. Options include hours, days, weeks, or months. |
Requirements
Output
json— Response from the API endpoint 'campaignMetrics'.CustomerioApi.GetCustomerActivities
Retrieve recent activities for a customer. This tool returns a list of activities performed by or for a specified customer, such as attribute changes and message sends. It provides activity history from the past 30 days, with potential inclusion of older data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose activities you want to retrieve. |
activity_type_filter | string | Optional | Filter activities by specific type, such as 'add_relationship' or 'attribute_change'. |
customer_id_type | string | Optional | Specify the type of `customer_id` used to reference a person (e.g., `id`, `email`, or `cio_id`). Defaults to `id` if unspecified. |
event_or_attribute_name | string | Optional | Specify the event or attribute name to search for within activities of type `event` or `attribute_update`. |
max_results_per_page | integer | Optional | Specify the maximum number of activity results to retrieve per page. |
start_token | string | Optional | Token to specify which page of results to return. Use the `next` property from a previous response. |
Requirements
Output
json— Response from the API endpoint 'getPersonActivities'.CustomerioApi.GetCustomerInfo
Retrieve attributes and devices for specified customers by ID. Use this tool to get detailed attributes and devices information for up to 100 customers by their IDs. If a provided ID does not exist, it will be omitted in the response. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'getPeopleById'.CustomerioApi.GetCustomerProfileAttributes
Retrieve a customer's profile attributes. This tool fetches a list of attributes for a specified customer profile. Useful for creating segments or using in message templates.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_identifier | string | Required | The unique identifier of the customer to fetch their profile attributes. |
customer_id_type | string | Optional | Specifies the type of `customer_id` to reference a person. Options: 'id', 'email', 'cio_id'. Default is 'id' if not provided. |
Requirements
Output
json— Response from the API endpoint 'getPersonAttributes'.CustomerioApi.GetCustomerSegments
Retrieve segments of a specific customer from Customerio. Use this tool to get a list of segments that a specified customer profile is a part of. This can be useful for understanding customer categorization and targeting within the Customerio platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_identifier | string | Required | The unique ID of the customer for segment retrieval in Customerio. |
customer_id_type | string | Optional | Specifies the type of customer identifier to use ('id', 'email', or 'cio_id'). Default is 'id'. |
Requirements
Output
json— Response from the API endpoint 'getPersonSegments'.CustomerioApi.GetDeliveryMessageInfo
Retrieve metrics and details for a specific message delivery. Call this tool to get information and delivery metrics for a specific instance of a message intended for an individual recipient.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
message_identifier | string | Required | The unique identifier for a specific message instance to retrieve its information and metrics. |
Requirements
Output
json— Response from the API endpoint 'getMessage'.CustomerioApi.GetExportInfo
Returns information about a specific export from Customerio. Use this tool to fetch details about a particular export by providing the export ID. It retrieves comprehensive information related to the specified export.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
export_id_to_access | integer | Required | The unique ID of the export you want to access in Customerio. |
Requirements
Output
json— Response from the API endpoint 'getExport'.CustomerioApi.GetImportStatus
Retrieve the status of an import operation. Use this tool to get information on the status and results of a CSV file import operation, including the success of the row imports.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
import_id | integer | Required | The ID of the import to lookup from a previously queued import operation. |
Requirements
Output
json— Response from the API endpoint 'getImport'.CustomerioApi.GetNewsletterLinkMetrics
Retrieve metrics for link clicks in a newsletter. This tool fetches metrics for link clicks within a newsletter, providing both total counts and series data over specified periods (e.g., days, weeks). Useful for analyzing newsletter performance over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The identifier of the newsletter to retrieve metrics for. Must be an integer. |
include_unique_customers | boolean | Optional | If true, response includes only unique customer results (each customer counted once); if false, includes total click results. |
number_of_periods | integer | Optional | The number of periods to return metrics for. Defaults to maximum available, or 12 if in months. Maximums: 24 hours, 45 days, 12 weeks, or 121 months. |
time_unit_for_report | string | Optional | The unit of time for your report. Options are 'hours', 'days', 'weeks', or 'months'. |
Requirements
Output
json— Response from the API endpoint 'getNewsletterLinks'.CustomerioApi.GetNewsletterMessageMetadata
Retrieve delivery info for messages sent from a newsletter. Use this tool to get information about individual message deliveries from a specific newsletter. You can specify a time range using `start_ts` and `end_ts`, otherwise, it defaults to a 6-month period from the first delivery. For longer ranges, up to 12 months of data will be returned from the most recent delivery. Timestamps indicate delivery creation, not the actual send time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The unique identifier of the newsletter to retrieve delivery information for. |
begin_query_timestamp | integer | Optional | The Unix timestamp marking the start of the time range for your query. Without this, data defaults to the earliest available from 6 months prior. |
ending_timestamp_for_query | integer | Optional | The ending timestamp for your query in Unix format. It specifies the end of the time range for retrieving message delivery data. |
metrics_to_return | string | Optional | Specify one or more metrics to return, such as 'attempted', 'sent', 'delivered', etc. |
pagination_start_token | string | Optional | The token to specify the start of the result page to return. Use the `next` value from previous responses for pagination. |
results_per_page_limit | integer | Optional | The maximum number of message delivery results to retrieve per page. |
Requirements
Output
json— Response from the API endpoint 'getNewsletterMsgMeta'.CustomerioApi.GetNewsletterMetrics
Retrieve metrics for a specific newsletter over time. This tool retrieves a list of metrics for an individual newsletter over specified time intervals, such as days or weeks, presented from oldest to newest. It is useful to analyze the performance of newsletters over time, requiring at least two time steps for valid data retrieval.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The identifier for the specific newsletter to retrieve metrics for. Expected to be an integer. |
item_type_for_metrics | string | Optional | Specify the type of item to return metrics for, such as 'email', 'webhook', 'twilio', etc. If not provided, metrics for all types are returned. |
number_of_time_periods | integer | Optional | The number of time periods to return metrics for. Minimum is 2. Defaults to max: 24 hours, 45 days, 12 weeks, 121 months. Use this to specify the time span for newsletter metrics. |
time_period_unit | string | Optional | The unit of time to report metrics (options: hours, days, weeks, months). |
Requirements
Output
json— Response from the API endpoint 'getNewsletterMetrics'.CustomerioApi.GetNewsletters
Retrieve a list of newsletters and their metadata. Use this tool to obtain a comprehensive list of newsletters along with detailed metadata. Ideal for managing or reviewing newsletter information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_results_per_page | integer | Optional | The maximum number of newsletters to retrieve per page, up to 100. |
sort_order | string | Optional | Specify the order to sort results: `asc` for chronological, `desc` for reverse. |
start_token | string | Optional | Token to retrieve a specific page of newsletter results. Use the `next` property from previous responses as this token. |
Requirements
Output
json— Response from the API endpoint 'listNewsletters'.CustomerioApi.GetNewsletterTestGroups
Retrieve test group details for a specific newsletter. Use this tool to obtain information about each test group within a specific newsletter, including content IDs for each group. Ideal for analyzing or verifying test group configurations in newsletters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The unique identifier of a newsletter to retrieve its test group details. |
Requirements
Output
json— Response from the API endpoint 'getNewsletterTestGroups'.CustomerioApi.GetNewsletterVariantClickMetrics
Get link click metrics for a newsletter variant. Retrieve metrics related to link clicks for an individual newsletter variant, such as language variations or A/B test messages. By default, the data covers up to 45 days. Specify the period and steps to customize the data range.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
message_content_identifier | integer | Required | The ID of a specific message within a newsletter, useful for A/B tests or multilingual newsletters. Retrieve from newsletter details. |
newsletter_identifier | integer | Required | The unique integer identifier of a specific newsletter to retrieve click metrics. |
item_type_for_metrics | string | Optional | The type of item to return metrics for. Options are: email, webhook, twilio, slack, push, in_app. When left empty, metrics for all types are included. |
number_of_periods | integer | Optional | Specify the number of time periods to retrieve data for. Defaults to the maximum if not specified, or 12 for months. Maximum limits: 24 hours, 45 days, 12 weeks, or 121 months. |
time_unit_for_report | string | Optional | The unit of time for generating the report. Options are: hours, days, weeks, months. |
Requirements
Output
json— Response from the API endpoint 'getVariantLinks'.CustomerioApi.GetNewsletterVariantInfo
Retrieve variant details of a specific newsletter. Use this tool to obtain details about a specific variant of a newsletter, which could represent a language option or part of an A/B test.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
message_identifier_in_newsletter | integer | Required | Identifier for a message within a newsletter, used for A/B tests or multi-language editions. |
newsletter_identifier | integer | Required | The unique identifier for a newsletter. Required to retrieve specific variant information. |
Requirements
Output
json— Response from the API endpoint 'getNewsletterVariant'.CustomerioApi.GetNewsletterVariantMetrics
Fetch metrics for a specific newsletter variant. This tool retrieves metrics for an individual newsletter variant, such as a language variation or A/B test version. It provides total metrics and stepped metrics over a specified time period, which are arranged chronologically. It requires at least two steps to retrieve data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The unique identifier for the newsletter to fetch metrics for. |
newsletter_message_id | integer | Required | The ID of a message in a newsletter, used for identifying variants or languages within a newsletter. Useful for A/B tests or multilingual content. |
item_type_for_metrics | string | Optional | Specify the type of item to return metrics for (e.g., email, webhook, etc.). If left empty, metrics for all types are returned. |
number_of_period_steps | integer | Optional | The number of time periods to return, requiring a minimum of 2 steps. Maximum limits apply based on the period type. |
reporting_period_unit | string | Optional | The time unit for the report, such as 'hours', 'days', 'weeks', or 'months'. Used to define the granularity of the metrics. |
Requirements
Output
json— Response from the API endpoint 'getVariantMetrics'.CustomerioApi.GetNewsletterVariants
Fetch content variants for a specified newsletter. Use this tool to retrieve different content variants of a newsletter, useful for accessing multi-language versions or A/B test variations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The unique integer identifier of a newsletter to fetch its content variants. |
Requirements
Output
json— Response from the API endpoint 'listNewsletterVariants'.CustomerioApi.GetNewsletterVariantTranslation
Get information on a newsletter's language variant. Use this tool to obtain details about a particular language variant of a newsletter. Ideal for retrieving specific translations of newsletter content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
language_tag | string | Required | The language tag of a newsletter variant. Leave empty for default language. |
newsletter_identifier | integer | Required | The unique identifier of a newsletter to retrieve its specific language variant. |
Requirements
Output
json— Response from the API endpoint 'getNewsletterVariantTranslation'.CustomerioApi.GetObjectAttributes
Retrieve a list of attributes for a specific object. Use this tool to get attributes of an object, such as account name, billing date, etc., by specifying the object type and ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_identifier | string | Required | The unique identifier for the object, which can be either `object_id` or `cio_object_id`, depending on the id_type specified in query params. |
object_type_identifier | integer | Required | The ID representing the object type, beginning at 1 for each new type, like 'Companies' or 'Accounts'. |
object_id_type | string | Optional | Specify the type of ID used for the object: 'object_id' or 'cio_object_id'. |
Requirements
Output
json— Response from the API endpoint 'getObjectAttributes'.CustomerioApi.GetObjectTypes
Retrieve a list of object types and their IDs. Use this tool to obtain a list of all available object types in your system along with their incrementing IDs. This is useful when you need to query, create, or modify specific object types by their ID.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getObjectTypes'.CustomerioApi.GetPeopleByEmail
Retrieve a list of people matching an email address. Use this tool to find people in your workspace based on their email address. It returns a list of individuals matching the specified email.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_email_address | string | Required | The email address to find in the workspace. Returns a list of individuals matching this email. |
Requirements
Output
json— Response from the API endpoint 'getPeopleEmail'.CustomerioApi.GetPersonRelationships
Retrieve a list of objects a person is related to. Use this tool to obtain a list of relationships associated with a specific person. It supports pagination for retrieving results in multiple pages. Note that duplicates may appear across pages.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose relationships you wish to retrieve. |
max_results_per_page | integer | Optional | The maximum number of results to retrieve per page. |
pagination_start_token | string | Optional | Token to specify the page of results to return. Use the `next` property's value from a previous response to get subsequent pages. |
Requirements
Output
json— Response from the API endpoint 'getPersonRelationships'.CustomerioApi.GetSegmentCustomerCount
Retrieve the customer count for a specific segment. Use this tool to obtain the number of customers belonging to a particular segment identified by segment_id. This can help in analyzing segment size and its potential impact.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_id | integer | Required | The unique identifier for the segment to retrieve the customer count. Find this ID on the segment's page or via the App API. |
Requirements
Output
json— Response from the API endpoint 'getSegmentCount'.CustomerioApi.GetSegmentInfo
Retrieve information about a specific segment. This tool retrieves detailed information about a specific segment using its segment ID. It should be called when segment information is needed for analysis or decision-making.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_identifier | integer | Required | The ID for a segment. Find this on its page in the dashboard or using the App API. |
Requirements
Output
json— Response from the API endpoint 'getSegment'.CustomerioApi.GetSegmentMembers
Retrieve customer details from a specific segment. Use this tool to get a list of customer identifiers in a specified segment. It returns identifiers for each person in the segment, providing more comprehensive information than just IDs. Useful for understanding customer segmentation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_identifier | integer | Required | The unique identifier for a segment. Find this ID on the segment's page in the dashboard, under *Usage*. |
maximum_results_per_page | integer | Optional | Specify the maximum number of customer identifiers to retrieve per page. |
pagination_token | string | Optional | Token to specify the start of the page of results. Use the `next` value from a previous response to paginate. |
Requirements
Output
json— Response from the API endpoint 'getSegmentMembership'.CustomerioApi.GetSenderInfo
Retrieve information about a specific sender by ID. Use this tool to get detailed information for a specific sender using their ID, which is helpful for email management and verification processes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
sender_identifier | integer | Required | The unique identifier for a sender, required to fetch their information. |
Requirements
Output
json— Response from the API endpoint 'getSender'.CustomerioApi.GetSenderList
Retrieve a list of senders from your workspace. This tool retrieves a list of senders in your workspace, representing the identities from which messages are sent. Use this to manage or display sender information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_results_per_page | integer | Optional | The maximum number of sender results to retrieve per page. Specify an integer value. |
pagination_token | string | Optional | Token for the page of results to return. Use the `next` property from the response for pagination. |
results_sort_order | string | Optional | Sort results: 'asc' for chronological, 'desc' for reverse chronological order. |
Requirements
Output
json— Response from the API endpoint 'listSenders'.CustomerioApi.GetSenderUsage
Retrieve campaigns and newsletters using a specific sender. Use this tool to obtain lists of campaigns and newsletters that utilize a particular sender identity. It provides insights into where a sender is actively used, helping in managing and analyzing sender strategies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
sender_identifier | integer | Required | The unique identifier for the sender to retrieve associated campaigns and newsletters. |
Requirements
Output
json— Response from the API endpoint 'getSenderUsage'.CustomerioApi.GetSubscriptionPreferences
Retrieve a person's subscription preferences. Returns a list of a person's subscription preferences, including headers, topic names, and descriptions. The data is translated if a language is specified in the query.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_identifier | string | Required | The ID of the customer to retrieve subscription preferences for. |
accept_language | string | Optional | Language tag for translating content. If not specified, defaults to the subscription center's language. |
customer_id_type | string | Optional | Type of customer_id used to reference a person, e.g., 'id', 'email', or 'cio_id'. Defaults to 'id'. |
translation_language | string | Optional | Specify the language tag for translating the subscription preferences content. If not provided, the default language is used. |
Requirements
Output
json— Response from the API endpoint 'getPersonSubscriptionPreferences'.CustomerioApi.GetSubscriptionTopics
Retrieve subscription topics from your workspace. Use this tool to get the list of all subscription topics available in your workspace. It will return an empty array if no topics exist.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getTopics'.CustomerioApi.GetTransactionalLinkMetrics
Retrieve metrics for clicked links in transactional messages. This tool returns metrics for links clicked from a transactional message, including totals and metrics over specified time periods. Useful for analyzing link engagement trends over days, weeks, etc. Cannot request fewer than two periods (e.g., days or weeks).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transactional_message_id | integer | Required | The identifier for the transactional message, found in the UI or URL (e.g., in `/transactional/3/templates/139`, the ID is 3). |
include_only_unique_customers | boolean | Optional | Return only unique customer results if true; false includes all click instances. |
number_of_periods | integer | Optional | Specify the number of periods to return metrics for. Cannot be fewer than 2 periods. Defaults to the maximum available, or 12 if the period is in months. Maximums: 24 hours, 45 days, 12 weeks, or 121 months. |
time_unit_for_report | string | Optional | The unit of time for the report. Options are: hours, days, weeks, or months. |
Requirements
Output
json— Response from the API endpoint 'transactionalLinks'.CustomerioApi.GetTransactionalMessage
Retrieve details of a transactional message. Call this tool to get information about an individual transactional message using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transactional_message_id | integer | Required | The ID of the transactional message, found in the UI or URL, e.g., `/transactional/3/templates/139` has an ID of 3. |
Requirements
Output
json— Response from the API endpoint 'getTransactional'.CustomerioApi.GetTransactionalMessageDeliveries
Fetch delivery details for transactional messages. Retrieve information about individual message deliveries from a transactional message. Use optional parameters to specify a time range for the message data, otherwise, data from the last 6 months is returned by default.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transactional_message_id | integer | Required | The unique identifier for the transactional message, found in the UI or URL, e.g., '/transactional/3/templates/139' where the ID is 3. |
beginning_timestamp | integer | Optional | The start time for the query, specified as a Unix timestamp. Limits the query to data starting from this time. |
broadcast_state | string | Optional | Specifies the state of the broadcast to filter results. Options are 'failed', 'sent', 'drafted', or 'attempted'. |
max_results_per_page | integer | Optional | The maximum number of results to return per page, as an integer. |
page_token | string | Optional | Specify the token for the page of results you want to return. Use the `next` property from previous responses as the value to paginate. |
query_ending_timestamp | integer | Optional | The ending timestamp for the query, determining the end of the time range for message data retrieval. |
return_metrics | string | Optional | Specify one or more metrics to return, such as 'sent', 'delivered', or 'clicked'. |
Requirements
Output
json— Response from the API endpoint 'transactionalMessages'.CustomerioApi.GetTransactionalMessageMetrics
Retrieve metrics for a transactional message over time periods. This tool retrieves metrics for a specified transactional message across defined time steps. It is useful for analyzing message performance over days, weeks, etc., from the oldest to the newest period.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transactional_message_id | integer | Required | The identifier of the transactional message. Found in the UI or URL, e.g., `/transactional/3/templates/139` means an ID of 3. |
number_of_periods | integer | Optional | The number of periods to retrieve metrics for. Defaults to the maximum available, or 12 if the period is in months. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month. |
time_unit_for_report | string | Optional | Specify the unit of time for the report, such as 'hours', 'days', 'weeks', or 'months'. |
Requirements
Output
json— Response from the API endpoint 'transactionalMetrics'.CustomerioApi.GetTransactionalMessageVariants
Retrieve content variants of a transactional message. This tool is used to obtain the different language variants of a transactional message's content. It should be called when you need to access the available language or format options for a specific message.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transactional_message_id | integer | Required | The ID of the transactional message, found in the UI or URL, e.g., `/transactional/3/templates/139` means ID is 3. |
Requirements
Output
json— Response from the API endpoint 'listTransactionalVariants'.CustomerioApi.GetTransactionalVariant
Fetch translation details of a transactional message. Use this tool to obtain details about a translation of a specific transactional message, including its content. It's useful when you need to access different language variants of transactional messages.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
language_tag | string | Required | Specify the language tag for the message variant. Use an empty string for the default language. If the variant does not exist, an error is returned. |
transactional_message_id | integer | Required | The identifier of the transactional message, found in the UI or URL, e.g., `/transactional/3/templates/139` has an ID of 3. |
Requirements
Output
json— Response from the API endpoint 'getTransactionalVariant'.CustomerioApi.GetWebhookInfo
Get detailed information about a specific webhook. This tool retrieves information about a specific reporting webhook from Customerio. It should be called when you need details about a particular webhook identified by its webhook ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_identifier | integer | Required | The unique identifier of the webhook you want to retrieve information for. This should be an integer. |
Requirements
Output
json— Response from the API endpoint 'getWebhook'.CustomerioApi.ListBroadcasts
Retrieve a list of API-triggered broadcasts with metadata. Use this tool to get detailed information on all your API-triggered broadcasts, including their metadata. Ideal for keeping track of broadcast activities or managing campaigns.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listBroadcasts'.CustomerioApi.ListCampaignActions
Retrieve operations in a campaign workflow. This tool retrieves the actions or 'tiles' in a campaign workflow, returning up to 10 actions per call. If more pages of results are available, a 'next' string is included, which can be used to access subsequent pages. Ideal for analyzing or modifying campaign workflows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_id | integer | Required | The ID of the campaign to retrieve workflow information for. Must be an integer. |
page_token | string | Optional | Token for the results page to return. Use 'next' from the response as this value for subsequent pages. |
Requirements
Output
json— Response from the API endpoint 'listCampaignActions'.CustomerioApi.ListCollections
Retrieve a list of all collections including names and schemas. Use this tool to obtain all existing collections, providing both their names and schemas. Useful for managing database structures or viewing collection configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getCollections'.CustomerioApi.ListExports
Retrieve a list of exports for people or campaign metrics. This tool is used to obtain a list of exports, which are point-in-time records of people or campaign metrics. Call this tool when you need detailed information about exports from Customerio.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listExports'.CustomerioApi.ListRecentActivities
Retrieve recent activity logs from the past 30 days. This tool calls the Customerio API to obtain a list of recent activities for people. It returns activity history within the past 30 days, similar to workspace's Activity Logs, and might include older activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
activity_type | string | Optional | Specifies the type of activity to search for. Use specific activity types or patterns like `_o:<object_type_id>` for objects and `_r:<object_type_id>` for relationships. |
customer_id_type | string | Optional | Specify the type of `customer_id` to reference a person. Options are `id`, `email`, or `cio_id`. Default is `id`. |
event_or_attribute_name | string | Optional | The name of the event or attribute to return in the activity logs. |
include_deleted_people | boolean | Optional | If true, return results for deleted people in the list of activities. |
pagination_token | string | Optional | Token to specify the page of results to return. Use the `next` property from the previous response. |
person_identifier | string | Optional | The identifier for the person to look up, which can be their `id`, `email`, or `cio_id`. Prefix with `cio_` for `cio_id`. |
results_per_page_limit | integer | Optional | Specify the maximum number of activity results to retrieve per page. |
Requirements
Output
json— Response from the API endpoint 'listActivities'.CustomerioApi.ListReportingWebhooks
Retrieve a list of reporting webhooks. Use this tool to get a list of all reporting webhooks configured in your Customerio account. It should be called when you need to access or manage existing reporting webhooks.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listWebhooks'.CustomerioApi.ListSnippetsWorkspace
Retrieve a list of reusable content snippets from your workspace. Use this tool to obtain snippets, such as common footers, which are reusable content pieces in your workspace.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listSnippets'.CustomerioApi.ListTransactionalMessages
Retrieve your list of transactional message IDs. This tool retrieves a list of your transactional message IDs used for triggering individual deliveries. It does not include delivery instances themselves.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listTransactional'.CustomerioApi.ListWorkspaces
Retrieve a list of workspaces in your account. Use this tool to get information about all workspaces available in your Customerio account. It provides a list that can be used to view or manage workspaces.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listWorkspaces'.CustomerioApi.RemoveEmailSuppression
Remove an email address from the suppression list. Use this tool to remove a specific email address from the email service provider's suppression list, allowing future communications to be sent to it.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_address_to_remove | string | Required | The email address to remove from the suppression list, allowing future communications. |
suppression_reason | string | Required | The reason the email address was suppressed (e.g., 'bounces', 'spam_reports'). |
Requirements
Output
json— Response from the API endpoint 'deleteSuppression'.CustomerioApi.RemoveUnusedSnippet
Removes an unused snippet from the system. This tool removes a snippet that is not in use. If the snippet is currently in use, an error will be returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
snippet_name | string | Required | The name of the snippet to be removed. Must be unused to avoid errors. |
Requirements
Output
json— Response from the API endpoint 'deleteSnippet'.CustomerioApi.ReplaceCollectionContents
Replace the entire contents of a data collection. Use this tool to completely replace the existing contents of a data collection by specifying the new keys and values. Ideal for cases where a full update is required. Keep in mind the size limitations: collections must not exceed 10 MB and no single row more than 10 KB. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
collection_identifier | integer | Optional | The unique identifier for the collection whose contents are being replaced. This is required for identifying the specific collection to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateCollectionContents'.CustomerioApi.RetrieveCollectionContents
Retrieve contents of a specified collection. Use this tool to fetch the data stored in a specific collection on the Customerio platform. It returns each row as a JSON object, ideal for accessing stored information quickly.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collection_identifier | integer | Required | The unique identifier for the collection to retrieve contents from. |
Requirements
Output
json— Response from the API endpoint 'getCollectionContents'.CustomerioApi.RetrieveCollectionDetails
Retrieve details about a specific collection. This tool retrieves information about a collection, including its schema and name, without including the content of the collection. It should be used when you need information about the structure and title of a collection.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collection_identifier | integer | Required | The unique identifier for a specific collection to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'getCollection'.CustomerioApi.RetrieveCustomerMessages
Retrieve deliveries sent to a customer within a time range. Use parameters to specify the time range for the messages you want to retrieve. If no time range is provided, it defaults to the most recent 6 months. The tool returns data on when deliveries were created, which may differ from when they were sent.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_identifier | string | Required | The unique ID of the customer whose message deliveries you want to retrieve. |
customer_id_type | string | Optional | Specifies the type of customer_id used to reference a person. Options: 'id', 'email', 'cio_id'. Defaults to 'id' if not provided. |
max_results_per_page | integer | Optional | The maximum number of results to retrieve per page. This limits the number of messages returned in a single response. |
pagination_token | string | Optional | Token for the page of results to return. Use the `next` property from previous responses to get the next page. |
query_end_timestamp | integer | Optional | The ending timestamp (in integer format) for the query to limit data retrieval to specific time ranges. |
starting_timestamp | integer | Optional | The beginning timestamp for the query in integer format, used to filter messages by start date. |
Requirements
Output
json— Response from the API endpoint 'getPersonMessages'.CustomerioApi.RetrieveNewsletterLanguageVariant
Get info on a newsletter's language variant in A/B test. Use this tool to obtain details about a specific language variant of a newsletter that is part of an A/B test. It requires the newsletter ID, test group ID, and language code.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ab_test_group_id | string | Required | The unique ID of the A/B test group for retrieving the language variant. |
language_tag | string | Required | Specify the language tag of the newsletter variant. Use an empty string to default to your primary language. |
newsletter_identifier | integer | Required | Specify the unique identifier of the newsletter to retrieve its language variant details. |
Requirements
Output
json— Response from the API endpoint 'getNewsletterVariantTranslationTest'.CustomerioApi.RetrieveNewsletterMetadata
Retrieve metadata for an individual newsletter. Call this tool to get detailed information about a specific newsletter using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
newsletter_identifier | integer | Required | The unique identifier for the newsletter to retrieve metadata. |
Requirements
Output
json— Response from the API endpoint 'getNewsletters'.CustomerioApi.SendTransactionalEmail
Send a customizable transactional email. Use this tool to send a transactional email using Customerio. You can utilize a `transactional_message_id` to specify a template or customize the email by providing `body`, `subject`, and `from` values. If a metrics association is needed, include the `transactional_message_id`. It's designed for sending personalized messages while tracking delivery metrics effectively. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'sendEmail'.CustomerioApi.SendTransactionalPushNotification
Send a customized transactional push notification. This tool sends a transactional push notification using a specified message template from Customerio. You can override template values at send time using the `transactional_message_id`, which can be the numerical ID or the Trigger Name. Use this tool to send personalized push messages to users. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'sendPush'.CustomerioApi.SendTransactionalSms
Send a transactional SMS message using a template. Send a transactional SMS by providing a `transactional_message_id`, which can be the numerical ID or *Trigger Name* of your message template. This allows you to automate SMS communications using predefined templates. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'sendSMS'.CustomerioApi.SuppressEmailAtEsp
Suppress an email address at the email service provider. Use this tool to suppress an email address at the email service provider (ESP). It ensures that the email address will no longer receive emails through the ESP, while allowing the contact to remain in your Customer.io workspace.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_address_to_suppress | string | Required | The email address of the person you want to suppress at the ESP. |
suppression_reason | string | Required | Specify the reason for suppressing the email address, such as 'bounces' or 'spam_reports'. |
Requirements
Output
json— Response from the API endpoint 'postSuppression'.CustomerioApi.TranslateCampaignMessage
Fetches a translated message for a specific campaign action. Returns a translated version of a message in a campaign using the action ID and specified language. Use when a translated version of a campaign message is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
campaign_action_id | integer | Required | The ID of the action to look up or act on within the campaign. |
campaign_id | integer | Required | The numeric ID of the campaign to get information about or trigger. |
target_language | string | Required | A language tag for the language variant to translate to. Defaults to the default language if empty. Returns an error if the variant doesn't exist. |
Requirements
Output
json— Response from the API endpoint 'getCampaignActionTranslation'.CustomerioApi.TriggerBroadcastMessage
Trigger a broadcast to a specific audience using Customerio. This tool triggers a broadcast campaign in Customerio, allowing for message personalization via provided data. It should be called when you need to send messages to an audience already in your workspace, specified by a segment, email list, customer ID list, user map, or data file. It's important to handle existing users only, as the tool won't add or identify new users. Set flags to skip over non-existent users if needed. Designed for large audience message dispatch rather than individual interactions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
broadcast_id | integer | Optional | The unique ID of the broadcast campaign you want to trigger in Customerio. This ID is required to specify which broadcast to activate. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'triggerBroadcast'.CustomerioApi.UpdateBroadcastAction
Update the contents of a broadcast action. Use this tool to update the body of messages or HTTP requests in a broadcast action. It should be called when you need to modify the content associated with a specific broadcast action in Customerio. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
broadcast_id | integer | Optional | The identifier of a broadcast to update its contents. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
lookup_action_id | integer | Optional | The unique identifier for the action to update or modify in the broadcast. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateBroadcastAction'.CustomerioApi.UpdateBroadcastActionLanguage
Update the translation for a broadcast action. Use this tool to update the translation of a specific broadcast action, including message bodies or HTTP request content. This can be useful when you need to update translations for different languages in your broadcast actions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
broadcast_identifier | integer | Optional | The unique identifier for the broadcast you want to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
action_id | integer | Optional | The ID of the broadcast action you wish to update or query. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
broadcast_action_language | string | Optional | Specify the language tag for the broadcast translation. Defaults to the default language if an empty string is provided. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateBroadcastActionLanguage'.CustomerioApi.UpdateCampaignAction
Update campaign action details and content. This tool updates the contents of a specific campaign action, allowing modifications to messages and HTTP requests. Use it to edit existing campaign steps. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
campaign_id | integer | Optional | The numeric ID of the specific campaign to update or retrieve information about. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
action_id | integer | Optional | The identifier for the specific action within a campaign to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateCampaignAction'.CustomerioApi.UpdateCampaignActionTranslation
Update a language variant of a campaign action. Use this tool to update the contents of a language variant for a specific campaign action, including the message body and HTTP requests. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
campaign_id | integer | Optional | The ID of the campaign to update or retrieve information about. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
action_id | integer | Optional | The ID of the action to look up or act on for the campaign. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
language_tag | string | Optional | The language tag for the campaign action variant. Use an empty string for the default language. If the variant doesn't exist, an error is returned. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateCampaignActionTranslation'.CustomerioApi.UpdateCollectionInfo
Update collection name or replace its contents in Customerio. Use this tool to update the name or fully replace the contents of a specific collection in Customerio. Be careful when changing the collection name if it's referenced in active campaigns, as it will cause the references to return an empty data set. Ensure the collection size is within 10 MB and individual rows are no more than 10 KB. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
collection_identifier | integer | Optional | The unique identifier for the collection to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateCollection'.CustomerioApi.UpdateCustomerAttributes
Add or update customer attribute metadata in your workspace. Use this tool to add new customer attributes or update existing ones. It helps in managing customer data like names and emails, enhancing data understanding for AI tools, and setting sensitivity levels for premium users. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateAttributeMetadata'.CustomerioApi.UpdateEventMetadata
Update or add new events in the workspace. This tool allows you to update existing events or add new ones in the Customerio workspace. It is useful for managing customer actions and integrating new events. Events must be associated with customers via Pipelines or Track APIs to appear in the Data Index. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateEventMetadata'.CustomerioApi.UpdateNewsletterContent
Update a newsletter variant's content. Use this tool to update the content of a specific newsletter variant, such as a version in a different language or part of an A/B test. Ideal for modifying the body or detail changes in a newsletter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
newsletter_identifier | integer | Optional | The identifier of the newsletter you want to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
message_content_id | integer | Optional | The identifier for a message within a newsletter, used in A/B tests or multiple language variants. Retrieve IDs via getNewsletters. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateNewsletterVariant'.CustomerioApi.UpdateNewsletterTestTranslation
Update a newsletter's translation for A/B testing. This tool updates the translation of a specific newsletter variant within an A/B test. It's used when you need to modify the language content for different test groups in newsletter campaigns. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
newsletter_identifier | integer | Optional | The unique identifier for the newsletter. Use this to specify which newsletter to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
ab_test_group_id | string | Optional | The identifier for the A/B test group to update the newsletter translation for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
newsletter_language_tag | string | Optional | Specify a language tag for the newsletter translation. Utilize an empty string to default to your system's language. Invalid tags result in an error. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateNewsletterTestTranslation'.CustomerioApi.UpdateNewsletterVariantTranslation
Update a newsletter variant's translation. Use this tool to update the translation for a specific variant of a newsletter. This is applicable when your newsletter does not include A/B tests. For A/B tests, you should use a separate tool. Call this tool when you need to modify the language content of a newsletter variant for a given language. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
newsletter_identifier | integer | Optional | The unique identifier for a newsletter that you want to update the translation for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
language_tag | string | Optional | A language tag for the newsletter variant. If omitted, defaults to the company's default language. An error is returned if the language variant doesn't exist. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateNewsletterVariantTranslation'.CustomerioApi.UpdateOrCreateSnippet
Update or create a snippet with a unique name. Use this tool to update an existing snippet or create a new one. Pass a unique `name` and corresponding `value`. If the snippet already exists, its value will be updated; otherwise, a new snippet will be created. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateSnippets'.CustomerioApi.UpdateReportingWebhook
Update the configuration of a reporting webhook. Use this tool to modify the settings of a reporting webhook, such as enabling or disabling events or changing the webhook URL. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
webhook_identifier | integer | Optional | The unique identifier for the specific webhook to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateWebhook'.CustomerioApi.UpdateTransactionalEmail
Overwrite a transactional email's body with new content. Use this tool to update and fully overwrite the body of an existing transactional email. Ensure the updated content is tested as it will affect all future transactional email requests. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
transactional_email_id | integer | Optional | The ID of your transactional email. Found in the UI or URL of the transactional message. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
content_variant_id | integer | Optional | The unique identifier for the specific content version of your transactional email, found in the message URL. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateTransactional'.CustomerioApi.UpdateTransactionalMessageVariant
Fully update a language variant of a transactional message. Use this tool to overwrite the body and details of a specific language variant for an existing transactional message. This is useful for ensuring the message content is up-to-date and accurate across different languages. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path 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 path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
transactional_message_id | integer | Optional | The identifier of the transactional message. Found in the UI or URL of the message, e.g., `/transactional/3/templates/139` where the ID is 3. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
language_tag | string | Optional | Specify a language tag for a language variant. If not provided, default language is used. Errors if variant does not exist. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'updateTransactionalVariant'.CustomerioApi.UploadCsvToCustomerio
Upload a CSV file to Customerio for bulk data processing. Use this tool to upload a CSV file containing people, events, objects, or relationships to Customerio. The CSV must be hosted at a short-lived public URL, ideally expiring 2 hours after the upload. The endpoint performs basic validations and queues the import for processing, which occurs in multiple stages. You will receive a confirmation and a URL to check the import status. Any errors or warnings during the import can be accessed through downloadable CSV reports available via the export endpoints. 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.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'import'.