CustomerioApi

The CustomerioApi MCP Server offers a comprehensive suite of tools for managing customer communications and marketing campaigns through the Customer.io platform.

Available Tools

CustomerioApi.TriggerBroadcastMessage

Trigger a broadcast to a specific audience using Customerio.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastErrors

Retrieve details of broadcast validation errors.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.SendTransactionalEmail

Send a customizable transactional email.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.SendTransactionalPushNotification

Send a customized transactional push notification.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.SendTransactionalSms

Send a transactional SMS message using a template.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignList

Retrieve a list of marketing campaigns.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignMetadata

Retrieve metadata for a specific campaign.

Parameters

• campaign_id (integer, required) The ID of the campaign for which metadata is requested. Provide a valid integer.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignMetrics

Fetch metrics for an individual campaign.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignLinkMetrics

Get link click metrics for a campaign over specified periods.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListCampaignActions

Retrieve operations in a campaign workflow.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignMessages

Retrieve message deliveries from a campaign.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignActionInfo

Retrieve details for a specific action in a campaign.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateCampaignAction

Update campaign action details and content.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.TranslateCampaignMessage

Fetches a translated message for a specific campaign action.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateCampaignActionTranslation

Update a language variant of a campaign action.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignActionMetrics

Retrieve metrics for a specific campaign action.

Parameters

• 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).

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignActionLinkMetrics

Retrieve link click metrics for a specific campaign action.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCampaignJourneyMetrics

Retrieve journey metrics for a specific campaign.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListRecentActivities

Retrieve recent activity logs from the past 30 days.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListBroadcasts

Retrieve a list of API-triggered broadcasts with metadata.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastMetadata

Retrieve metadata for a specific broadcast.

Parameters

• broadcast_identifier (integer, required) The unique identifier for a specific broadcast. Use this to retrieve the corresponding metadata.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastStatus

Retrieve the status of a broadcast using its trigger ID.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastMetrics

Retrieve metrics for a specific broadcast over defined time steps.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastLinkMetrics

Retrieve metrics for link clicks in a broadcast.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastActions

Retrieve actions from a specific broadcast.

Parameters

• broadcast_identifier (integer, required) The unique identifier of the broadcast to retrieve its actions.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastMessageInfo

Retrieve details about broadcast message deliveries.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastActionInfo

Retrieve details of a specific broadcast action.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateBroadcastAction

Update the contents of a broadcast action.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastTranslationInfo

Retrieve translation info for a broadcast message.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateBroadcastActionLanguage

Update the translation for a broadcast action.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastActionMetrics

Retrieve metrics for a broadcast action over time steps.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastActionLinkMetrics

Retrieve link click metrics for a specific broadcast action.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetBroadcastTriggers

Retrieve triggers for a specific broadcast.

Parameters

• broadcast_identifier (integer, required) The identifier of a broadcast to retrieve its triggers. Must be an integer.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateCustomerAttributes

Add or update customer attribute metadata in your workspace.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateEventMetadata

Update or add new events in the workspace.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.CheckEmailSuppression

Retrieve suppression status and reason for an email.

Parameters

• email_to_check_suppression (string, required) The email address to check for suppression status and reasons.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.FindSuppressedEmailAddresses

Retrieve email addresses suppressed for specific reasons.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.RemoveEmailSuppression

Remove an email address from the suppression list.

Parameters

• 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’).

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.SuppressEmailAtEsp

Suppress an email address at the email service provider.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListExports

Retrieve a list of exports for people or campaign metrics.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetExportInfo

Returns information about a specific export from Customerio.

Parameters

• export_id_to_access (integer, required) The unique ID of the export you want to access in Customerio.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.DownloadExportSignedLink

Retrieve a temporary signed link to download an export.

Parameters

• export_identifier (integer, required) The unique ID of the export you want to access and download. Must be an integer.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ExportCustomerData

Export customer data based on specified filters.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ExportDeliveryData

Initiates export of delivery data for newsletters and campaigns.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UploadCsvToCustomerio

Upload a CSV file to Customerio for bulk data processing.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetImportStatus

Retrieve the status of an import operation.

Parameters

• import_id (integer, required) The ID of the import to lookup from a previously queued import operation.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetAllowlistIps

Retrieve IP addresses to allowlist for secure access.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.FetchMessageDeliveries

Retrieve a list of message deliveries and their metrics.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetDeliveryMessageInfo

Retrieve metrics and details for a specific message delivery.

Parameters

• message_identifier (string, required) The unique identifier for a specific message instance to retrieve its information and metrics.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetArchivedMessage

Retrieve an archived copy of a message delivery.

Parameters

• message_id (string, required) The unique identifier for the message to be retrieved.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletters

Retrieve a list of newsletters and their metadata.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.RetrieveNewsletterMetadata

Retrieve metadata for an individual newsletter.

Parameters

• newsletter_identifier (integer, required) The unique identifier for the newsletter to retrieve metadata.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.DeleteNewsletter

Delete an individual newsletter and its associated data.

Parameters

• newsletter_identifier (integer, required) The unique identifier of the newsletter you want to delete.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterMetrics

Retrieve metrics for a specific newsletter over time.

Parameters

• 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).

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterLinkMetrics

Retrieve metrics for link clicks in a newsletter.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterVariants

Fetch content variants for a specified newsletter.

Parameters

• newsletter_identifier (integer, required) The unique integer identifier of a newsletter to fetch its content variants.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterMessageMetadata

Retrieve delivery info for messages sent from a newsletter.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterVariantInfo

Retrieve variant details of a specific newsletter.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateNewsletterContent

Update a newsletter variant’s content.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterVariantTranslation

Get information on a newsletter’s language variant.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateNewsletterVariantTranslation

Update a newsletter variant’s translation.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterTestGroups

Retrieve test group details for a specific newsletter.

Parameters

• newsletter_identifier (integer, required) The unique identifier of a newsletter to retrieve its test group details.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.RetrieveNewsletterLanguageVariant

Get info on a newsletter’s language variant in A/B test.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateNewsletterTestTranslation

Update a newsletter’s translation for A/B testing.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterVariantMetrics

Fetch metrics for a specific newsletter variant.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetNewsletterVariantClickMetrics

Get link click metrics for a newsletter variant.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetObjectTypes

Retrieve a list of object types and their IDs.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.FindWorkspaceObjects

Find objects in your workspace using filter conditions.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetRelatedPeople

Retrieve people related to a specified object.

Parameters

• object_identifier (string, required) The ID of the object. This can be object_id or cio_object_id based on the id_type query parameter. Defaults to object_id.
• object_type_identifier (integer, required) The ID representing the object type, such as ‘Companies’ or ‘Accounts’. Starts from 1 and increments for each new type.
• identification_type (string, optional) Specifies whether the object identifier is an object_id or a cio_object_id. Choose between these two options.
• maximum_results_per_page (integer, optional) The maximum number of results to retrieve per page. Specify an integer value.
• pagination_start_token (string, optional) Token for starting the page of results. Use the ‘next’ property from a response to paginate.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetObjectAttributes

Retrieve a list of attributes for a specific object.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.CreateWebhook

Create a new webhook configuration for reporting.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListReportingWebhooks

Retrieve a list of reporting webhooks.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetWebhookInfo

Get detailed information about a specific webhook.

Parameters

• webhook_identifier (integer, required) The unique identifier of the webhook you want to retrieve information for. This should be an integer.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateReportingWebhook

Update the configuration of a reporting webhook.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.DeleteReportingWebhook

Delete a reporting webhook’s configuration.

Parameters

• webhook_identifier (integer, required) The unique identifier for the reporting webhook to be deleted.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.CreateManualSegment

Create a manual segment with name and description.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetAllSegments

Retrieve a list of all segments for your account.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSegmentInfo

Retrieve information about a specific segment.

Parameters

• segment_identifier (integer, required) The ID for a segment. Find this on its page in the dashboard or using the App API.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.DeleteManualSegment

Delete a specified manual segment by ID.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.FindSegmentDependencies

Identify campaigns and newsletters using a segment.

Parameters

• segment_identifier (integer, required) The ID for a segment, found on its dashboard page or via the App API.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSegmentCustomerCount

Retrieve the customer count for a specific segment.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSegmentMembers

Retrieve customer details from a specific segment.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSenderList

Retrieve a list of senders from your workspace.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSenderInfo

Retrieve information about a specific sender by ID.

Parameters

• sender_identifier (integer, required) The unique identifier for a sender, required to fetch their information.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSenderUsage

Retrieve campaigns and newsletters using a specific sender.

Parameters

• sender_identifier (integer, required) The unique identifier for the sender to retrieve associated campaigns and newsletters.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListSnippetsWorkspace

Retrieve a list of reusable content snippets from your workspace.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateOrCreateSnippet

Update or create a snippet with a unique name.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.RemoveUnusedSnippet

Removes an unused snippet from the system.

Parameters

• snippet_name (string, required) The name of the snippet to be removed. Must be unused to avoid errors.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSubscriptionTopics

Retrieve subscription topics from your workspace.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListTransactionalMessages

Retrieve your list of transactional message IDs.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetTransactionalMessage

Retrieve details of a transactional message.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetTransactionalMessageVariants

Retrieve content variants of a transactional message.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateTransactionalEmail

Overwrite a transactional email’s body with new content.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetTransactionalVariant

Fetch translation details of a transactional message.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateTransactionalMessageVariant

Fully update a language variant of a transactional message.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetTransactionalMessageMetrics

Retrieve metrics for a transactional message over time periods.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetTransactionalLinkMetrics

Retrieve metrics for clicked links in transactional messages.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetTransactionalMessageDeliveries

Fetch delivery details for transactional messages.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListWorkspaces

Retrieve a list of workspaces in your account.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.CreateNewCollection

Create a new data collection in Customerio.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ListCollections

Retrieve a list of all collections including names and schemas.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.RetrieveCollectionDetails

Retrieve details about a specific collection.

Parameters

• collection_identifier (integer, required) The unique identifier for a specific collection to retrieve its details.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.DeleteCollection

Delete a collection and its contents.

Parameters

• collection_id (integer, required) The unique identifier for the collection to be deleted.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.UpdateCollectionInfo

Update collection name or replace its contents in Customerio.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.RetrieveCollectionContents

Retrieve contents of a specified collection.

Parameters

• collection_identifier (integer, required) The unique identifier for the collection to retrieve contents from.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.ReplaceCollectionContents

Replace the entire contents of a data collection.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetPeopleByEmail

Retrieve a list of people matching an email address.

Parameters

• search_email_address (string, required) The email address to find in the workspace. Returns a list of individuals matching this email.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.FilterPeopleInWorkspace

Filter and search for people in your workspace.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• 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’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCustomerProfileAttributes

Retrieve a customer’s profile attributes.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetPersonRelationships

Retrieve a list of objects a person is related to.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCustomerInfo

Retrieve attributes and devices for specified customers by ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCustomerSegments

Retrieve segments of a specific customer from Customerio.

Parameters

• 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’.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.RetrieveCustomerMessages

Retrieve deliveries sent to a customer within a time range.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetCustomerActivities

Retrieve recent activities for a customer.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

CustomerioApi.GetSubscriptionPreferences

Retrieve a person’s subscription preferences.

Parameters

• 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.

Secrets

This tool requires the following secrets: CUSTOMERIO_API_KEY (learn how to configure secrets)

Reference

Below is a reference of enumerations used by some of the tools in the CustomerioApi MCP Server:

ToolMode

• GET_REQUEST_SCHEMA: get_request_schema
• EXECUTE: execute

pip install arcade_customerio_api