HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
Guides

Klaviyo MCP server

Configure Klaviyo's MCP server to get AI assistance with your Klaviyo data.

You will learn

The Klaviyo Model Context Protocol (MCP) server seamlessly integrates with Klaviyo’s APIs, enabling AI clients to interact with your Klaviyo data. This guide will walk you through configuring various MCP clients for both the remote-hosted MCP server (recommended) and the local MCP server.

What is MCP?

MCP (Model Context Protocol) is an open protocol that helps AI models securely interface with different data sources and tools. You’ll connect Klaviyo’s MCP server to an MCP client, i.e., an AI agent like Claude or Cursor, to get assistance with your Klaviyo data. Your MCP client can help with a variety of tasks from campaign creation to flow performance reports. Here’s some examples of prompts you can give:

  • “Show me the performance of my email campaigns from the last 30 days.”
  • “Which flows are performing the best in terms of conversions?”
  • “Create an email campaign promoting our Memorial Day sale.”

Here’s an example of an MCP client working on a Klaviyo-related task using Klaviyo’s MCP tools:

Configure your MCP client for the remote-hosted server (recommended)

🚧

This feature is only available to Klaviyo users with an Owner, Admin, or Manager role. Learn more about Klaviyo user roles.

📘

By default, the remote-hosted server includes many tools. If your client has a smaller context window or you want to improve tool-selection accuracy, add the core-tools-only=true query parameter to limit the server to the ~40 core tools (see Query parameters).

To communicate with the Klaviyo MCP server, each MCP client needs specific configuration. Follow the steps below to get started:

  1. Log in to the Klaviyo account you'd like to use.
  2. Follow the steps below for the MCP client you’d like to configure.

Claude

Listed Connector (recommended for connecting to a single Klaviyo account)

The listed Klaviyo connector is the simplest way to access Klaviyo within Claude.

  1. In Claude, navigate to Settings > Connectors.

  2. Click Browse Connectors.

  3. Search for Klaviyo and connect.

  4. Review the Claude access and click Approve.

  5. Review the permissions for your Klaviyo account and click Allow.

You're now ready to ask Claude about your Klaviyo data.

Custom Connector (recommended for connecting to several Klaviyo accounts)

🚧

This feature is only available to Claude and Claude Desktop for users on Pro, Max, Team, and Enterprise plans.

For each Klaviyo account you would like to add,

  1. In Claude, navigate to Settings > Connectors.

  2. Click Add custom connector.

  3. Enter the following details in the connector modal:
    a. Name: Klaviyo

    1. If adding multiple accounts, include the name of the account you are connecting to distinguish it from others (e.g. "Klaviyo - Example Company")

    b. Remote MCP server URL: https://mcp.klaviyo.com/mcp

    1. If adding multiple accounts, include the name of the account as a query parameter (e.g. "https://mcp.klaviyo.com/mcp?company=example-company")

    e. Click Add.

  4. Next to the connector, click Connect.

  5. Review the Claude access and click Approve.

  6. Review the permissions for your Klaviyo account and click Allow.

For each new chat, click + > Connectors and ensure that only the relevant connector is enabled.

ChatGPT

ChatGPT App (recommended for connecting to a single Klaviyo account)

The Klaviyo ChatGPT App is the simplest way to interact with your account data within ChatGPT. For detailed instructions, refer to how to use the Klaviyo app for ChatGPT.

ChatGPT Custom MCP Server (recommended for connecting to several Klaviyo accounts)

First,

  1. In ChatGPT, navigate to Settings > Apps.

  2. In Advanced settings, toggle Developer mode on.

For each Klaviyo account you would like to add,

  1. Click Create app.

  2. Enter the following details in the connector modal:
    a. Name: Klaviyo

    1. If adding multiple accounts, include the name of the account you are connecting to distinguish it from others (e.g. "Klaviyo - Example Company")

    b. MCP Server URL: https://mcp.klaviyo.com/mcp
    c. Authentication: Select OAuth
    d. Select I understand and want to continue
    e. Click Create.

  3. Review the ChatGPT access and click Approve.

  4. If adding multiple accounts, choose the account you want to connect.

  5. Review the permissions for your Klaviyo account and click Allow.

For each new chat, click + > More and select the correct server.

Cursor

  1. Download Cursor.

  2. Open Cursor. Within Settings > Cursor Settings > MCP > New MCP Server, add the following:

{
  "mcpServers": {
    "klaviyo": {
      "url": "https://mcp.klaviyo.com/mcp"
    }
  }
}

See Query parameters to choose any query parameters you'd like to add to control server behavior.

  1. Save your changes and navigate to Settings > Cursor Settings > Tools & Integrations. Click Needs login. You will be prompted to authenticate the server.

🚧

If you encounter authentication errors, first Logout of the MCP Server and reauthenticate. If that fails, sign out of your Cursor account and then sign back in.

  1. Verify the connection by looking for visual indicators and asking a question to test the connection.

VS Code

  1. Download VS Code.

  2. Open VS Code. Within MCP User Configuration (Ctrl + Shift + P > MCP: Open User Configuration), add the following:

{
	"servers": {
		"klaviyo": {
			"url": "https://mcp.klaviyo.com/mcp"
		}
	}
}

If you already have a servers entry, append the Klaviyo configuration to it.

See Query parameters to choose any query parameters you'd like to add to control server behavior.

  1. Save your changes. From the command palette (Ctrl+Shift+P on Windows or Cmd+Shift+P on Mac), search for MCP: List Servers, then select klaviyo > Start Server. You will be prompted to authenticate the server.

🚧

The remote MCP server connection can sometimes take time to fully initialize and load all available tools. If the server fails to start or your initial test query does not work, you may need to restart VS Code a few times for the connection to fully register.

  1. Verify the connection by looking for visual indicators and asking a question to test the connection.

📘

To enable only the tools that do not modify any Klaviyo data, add the query parameter read-only=true to the URL in your MCP client’s configuration file.

Other Clients

Our server is compatible with any MCP client that supports remote servers. You may need the following info when connecting:

Query parameters

You can control server behavior with query parameters.

🚧

Query parameters can't be controlled with the listed Claude connector or the listed ChatGPT app. To use them, set up a custom connector instead (see Custom Connector under Claude and ChatGPT Custom MCP Server under ChatGPT above).

ParameterOptionsDefault valueDescription
read-onlytrue, falsefalseSetting this value to true disables any tools which can perform write actions on your Klaviyo account.
disable-tools-with-user-generated-contenttrue, falsefalseDisables specific tools that read user-generated content in your Klaviyo account that could be interpreted by your LLM (see Available tools). Be sure to carefully review each tool call to ensure your client is not acting on malicious instructions.
core-tools-onlytrue, falsefalse (true for ChatGPT)Setting this value to true limits the server to the ~40 core tools. This reduces the number of tools loaded into your client, which can help clients with smaller context windows and improve tool-selection accuracy. Defaults to true for ChatGPT clients.
include-output-schemastrue, falsetrue (false for ChatGPT)Controls whether output schemas are included in the tools list. Defaults to false for ChatGPT clients.
betatrue, falsefalseSetting this value to true enables access to new, potentially unstable tools.
toolsetsComma-separated list of API scopesAll toolsLimits the server to tools whose required API scopes all fall within the list you provide. Provide the scopes in resource:access form (e.g. toolsets=profiles:read,campaigns:read); see the Available scopes for each API section of the authentication guide for the full list. Only tools whose required scopes are fully covered by your list are exposed.

Here's an example of what your URL may look like:

https://mcp.klaviyo.com/mcp?read-only=true&disable-tools-with-user-generated-content=true&core-tools-only=true&toolsets=profiles:read,campaigns:read

Configure your MCP client for the local server

To use the local MCP server, you’ll need:

  • uv
  • A compatible MCP client (e.g., Cursor). For web-based clients such as ChatGPT, use our remote-hosted server.

To communicate with the Klaviyo MCP server, each MCP client needs specific configuration. Follow the steps below to get started:

  1. To utilize all available tools, create a Klaviyo private API key with the following permissions:
ScopeAccess
AccountsRead
CampaignsFull
CatalogsRead
EventsFull
FlowsRead
ImagesFull
ListRead
MetricsRead
ProfilesFull
SegmentsFull
SubscriptionsFull
TagsRead
TemplatesFull
TranslationsFull
  1. Follow the steps below for the MCP client you’d like to configure.

📘

You can add multiple Klaviyo accounts to your MCP client's configuration file to switch between accounts without editing the file each time. Just be sure to reference the desired account in each prompt.

Claude Desktop

  1. Download Claude Desktop.

  2. Open Claude Desktop. Within Settings > Developer > Edit Config, add the following, substituting your API key:

{
 "mcpServers": {
   "klaviyo": {
     "command": "uvx",
     "args": ["klaviyo-mcp-server@latest"],
     "env": {
       "PRIVATE_API_KEY": "YOUR_API_KEY",
       "READ_ONLY": "false",
       "ALLOW_USER_GENERATED_CONTENT": "false"
     }
   }
 }
}
  1. Once you have saved all configuration changes, terminate all Claude processes and relaunch Claude to apply the new settings.

  2. Verify the connection by looking for visual indicators and asking a question to test the connection.

📘

If you get errors upon starting Claude, you may need to provide the full path to the uvx executable for the command key. On macOS, find this by running which uvx.

  1. (Recommended for security) To avoid storing your API key in plaintext, save your API key in your password manager. Then, use the following command to launch Claude, pasting in your API key when prompted:
uvx --from klaviyo-mcp-server@latest run-claude

Note that as of now, this only supports MacOS and Windows.

📘

Note for free users

The free version of Claude Desktop has a very limited context window, and you may run into issues with all the tools enabled. Here are a few possible workarounds:

  1. Only enable the tools you need. To do this, click the Search and tools button near the prompt. Then, click klaviyo to toggle certain tools on or off.
  2. Use read-only mode, i.e., set READ_ONLY to true.
  3. Use a different client.

Cursor

  1. Download Cursor.

  2. Open Cursor. Within Settings > Cursor Settings > Tools & Integrations > Add Custom MCP, add the following, substituting your API key:

{
  "mcpServers": {
    "klaviyo": {
      "command": "uvx",
      "args": ["klaviyo-mcp-server@latest"],
      "env": {
        "PRIVATE_API_KEY": "YOUR_API_KEY",
        "READ_ONLY": "false",
        "ALLOW_USER_GENERATED_CONTENT": "false"
      }
    }
  }
}
  1. Once you have saved all configuration changes, terminate all Cursor processes and relaunch Cursor to apply the new settings.

  2. Verify the connection by looking for visual indicators and asking a question to test the connection.

  3. (Recommended for security) To avoid storing your API key in plaintext, save your API key in your password manager. Then, use the following command to launch Cursor, pasting in your API key when prompted:

uvx --from klaviyo-mcp-server@latest run-cursor

Note that as of now, this only supports MacOS and Windows.

VS Code

  1. Download VS Code.

  2. Open VS Code. Within settings (Ctrl + Shift + P > Preferences: Open Settings (JSON)), add the following:

{
  "mcp": {
    "servers": {
      "klaviyo": {
        "command": "uvx",
        "args": ["klaviyo-mcp-server@latest"],
        "env": {
          "PRIVATE_API_KEY": "${input:klaviyo_api_key}",
          "READ_ONLY": "false",
          "ALLOW_USER_GENERATED_CONTENT": "false"
        }
      }
    },
    "inputs": [
      {
        "type": "promptString",
        "id": "klaviyo_api_key",
        "description": "Klaviyo API Key",
        "password": true
      }
    ]
  }
}
  1. Once you have saved all configuration changes, terminate all VS Code processes and relaunch VS Code to apply the new settings.

  2. Verify the connection by looking for visual indicators and asking a question to test the connection.

📘

To enable only the tools that do not modify any Klaviyo data, set the READ_ONLY environment variable to true in your MCP client’s configuration file.

Environment configuration

The Klaviyo MCP server provides some configuration options which can be controlled with environment variables.

envOptionsDefault valueDescription
READ_ONLYtrue, falsefalseSetting this value to true disables any tools which can perform write actions on your Klaviyo account.
ALLOW_USER_GENERATED_CONTENTtrue, falsetrueSetting this value to false disables specific tools from reading and interpreting user-generated content in your Klaviyo account using your LLM (see Available tools). If left as true, be sure to carefully review each tool call to ensure your client is not acting on malicious instructions.

Add multiple accounts to your configuration file

To avoid editing your MCP client's configuration file each time you switch Klaviyo accounts, you can add multiple accounts to the file.

To do this:

  1. Copy and paste the same configuration shown above for each account you want to add.
  2. Update the name, i.e., klaviyo, to something more descriptive for each account, and replace the API keys accordingly.

Your config file should look like this:

{ 
  "mcpServers": { 
    "klaviyo_company1": { 
      "command": "uvx", 
      "args": ["klaviyo-mcp-server@latest"], 
      "env": { 
        "PRIVATE_API_KEY": "YOUR_API_KEY_1", 
        "READ_ONLY": "false", 
        "ALLOW_USER_GENERATED_CONTENT": "false" 
      } 
    },
    "klaviyo_company2": { 
      "command": "uvx", 
      "args": ["klaviyo-mcp-server@latest"], 
      "env": { 
        "PRIVATE_API_KEY": "YOUR_API_KEY_2", 
        "READ_ONLY": "false", 
        "ALLOW_USER_GENERATED_CONTENT": "false" 
      } 
    }
  } 
}

Troubleshooting

If you are having trouble connecting to the remote server:

  • Ensure the URL is correct and there is no trailing slash: https://mcp.klaviyo.com/mcp.
  • Ensure you have the Owner, Admin, or Manager role on the Klaviyo account.

If your MCP client can’t find enabled MCP tools for Klaviyo:

  1. Review the steps above and ensure the MCP server is configured correctly.
  2. Terminate all processes and relaunch the app to refresh your client.

If you’re getting inaccurate or inconsistent responses:

  • Start a new chat to reset the conversation context.
  • Be specific in your queries by providing necessary, relevant keywords.

Available tools

CategoryTool nameDescriptionRead OnlyHas User Generated ContentAvailable on Remote Server
Accountsget_account_detailsGet details of your account.
Campaignsget_campaignsList your campaigns.
Campaignsget_campaignGet details of a campaign.
Campaignscreate_campaignCreate a campaign.
Campaignsassign_template_to_campaign_messageAssign an email template to a campaign message.
Campaignsget_campaign_send_jobGet the status of a campaign send job.
Campaignsget_campaign_recipient_estimation_jobGet the status of a campaign recipient estimation job.
Campaignsget_campaign_recipient_estimationGet the estimated number of recipients for a campaign.
Campaignsget_campaign_messageGet details of a campaign message.
Campaignsrefresh_campaign_recipient_estimationRefresh a campaign's recipient estimation.
Campaignscreate_campaign_cloneClone a campaign.
Campaignsupdate_campaignUpdate a campaign.
Campaignsdelete_campaignDelete a campaign.
Campaignsupdate_campaign_messageUpdate a campaign message.
Campaignsupdate_image_for_campaign_messageUpdate the image associated with a campaign message.
Campaignssend_campaignSend a campaign to its configured audience.
Campaignscancel_campaign_sendCancel or revert a campaign send.
Catalogsget_catalog_itemsList your catalog items.
Catalogsget_catalog_itemGet details of a catalog item.
Catalogsget_catalog_variantGet details of a catalog variant.
Catalogsget_catalog_categoryGet details of a catalog category.
Catalogsget_bulk_create_catalog_items_jobGet the status of a bulk catalog item create job.
Catalogsget_bulk_update_catalog_items_jobGet the status of a bulk catalog item update job.
Catalogsget_bulk_delete_catalog_items_jobGet the status of a bulk catalog item delete job.
Catalogsget_bulk_create_variants_jobGet the status of a bulk catalog variant create job.
Catalogsget_bulk_update_variants_jobGet the status of a bulk catalog variant update job.
Catalogsget_bulk_delete_variants_jobGet the status of a bulk catalog variant delete job.
Catalogsget_catalog_variantsList catalog variants.
Catalogsget_catalog_categoriesList catalog categories.
Catalogsget_bulk_create_catalog_items_jobsList bulk catalog item create jobs.
Catalogsget_bulk_update_catalog_items_jobsList bulk catalog item update jobs.
Catalogsget_bulk_delete_catalog_items_jobsList bulk catalog item delete jobs.
Catalogsget_bulk_create_variants_jobsList bulk catalog variant create jobs.
Catalogsget_bulk_update_variants_jobsList bulk catalog variant update jobs.
Catalogsget_bulk_delete_variants_jobsList bulk catalog variant delete jobs.
Catalogscreate_catalog_itemCreate a catalog item.
Catalogsupdate_catalog_itemUpdate a catalog item.
Catalogsdelete_catalog_itemDelete a catalog item.
Catalogsadd_categories_to_catalog_itemAdd categories to a catalog item.
Catalogsremove_categories_from_catalog_itemRemove categories from a catalog item.
Catalogsupdate_categories_for_catalog_itemUpdate the categories for a catalog item.
Catalogscreate_back_in_stock_subscriptionCreate a back-in-stock subscription.
Catalogscreate_catalog_variantCreate a catalog variant.
Catalogsupdate_catalog_variantUpdate a catalog variant.
Catalogsdelete_catalog_variantDelete a catalog variant.
Catalogscreate_catalog_categoryCreate a catalog category.
Catalogsupdate_catalog_categoryUpdate a catalog category.
Catalogsdelete_catalog_categoryDelete a catalog category.
Catalogsadd_items_to_catalog_categoryAdd items to a catalog category.
Catalogsremove_items_from_catalog_categoryRemove items from a catalog category.
Catalogsupdate_items_for_catalog_categoryUpdate the items in a catalog category.
Catalogsbulk_create_catalog_itemsCreate catalog items in bulk.
Catalogsbulk_update_catalog_itemsUpdate catalog items in bulk.
Catalogsbulk_delete_catalog_itemsDelete catalog items in bulk.
Catalogsbulk_create_catalog_variantsCreate catalog variants in bulk.
Catalogsbulk_update_catalog_variantsUpdate catalog variants in bulk.
Catalogsbulk_delete_catalog_variantsDelete catalog variants in bulk.
Eventsget_eventsList events.
Eventscreate_eventCreate an event for a profile.
Eventsget_metricsList event metrics.
Eventsget_metricGet details of an event metric.
Eventsquery_metric_aggregatesQuery and aggregate event data associated with a metric.
Eventsget_eventGet details of an event.
Eventsget_custom_metricGet details of a custom metric.
Eventsget_mapped_metricGet details of a mapped metric.
Eventsget_metric_propertyGet details of a metric property.
Eventsget_custom_metricsList custom metrics.
Eventsget_mapped_metricsList mapped metrics.
Eventsget_flows_triggered_by_metricList flows triggered by a metric.
Eventscreate_custom_metricCreate a custom metric.
Eventsupdate_custom_metricUpdate a custom metric.
Eventsdelete_custom_metricDelete a custom metric.
Eventsupdate_mapped_metricUpdate a mapped metric.
Eventsbulk_create_eventsCreate events for multiple profiles in bulk.
Eventsget_download_for_event_bulk_export_jobGet the download URL for an event bulk export job. (Beta)
Eventsget_event_bulk_export_jobGet the status of an event bulk export job.
Flowsget_flowsList your flows.
Flowsget_flowGet details of a flow.
Flowsget_flow_messageGet details of a flow message.
Flowsget_flow_actionGet details of a flow action.
Flowscreate_flowCreate a flow.
Flowsupdate_flowUpdate a flow's status.
Flowsdelete_flowDelete a flow.
Flowsupdate_flow_actionUpdate a flow action.
Groupsget_listsList your lists.
Groupsget_listGet details of a list.
Groupsget_segmentsList your segments.
Groupsget_segmentGet details of a segment.
Groupsget_flows_triggered_by_listList flows triggered by a list.
Groupsget_flows_triggered_by_segmentList flows triggered by a segment.
Groupscreate_listCreate a list.
Groupsupdate_listUpdate a list.
Groupsdelete_listDelete a list.
Groupsadd_profiles_to_listAdd profiles to a list.
Groupsremove_profiles_from_listRemove profiles from a list.
Groupscreate_segmentCreate a segment.
Groupsupdate_segmentUpdate a segment.
Groupsdelete_segmentDelete a segment.
Imagesupload_image_from_fileUpload image from a local file.
Imagesupload_image_from_urlUpload image from a URL.
Imagesget_imageGet details of an image.
Imagesget_imagesList images.
Imagesupdate_imageUpdate an image's metadata.
Profilesget_profilesList your profiles.
Profilesget_profileGet details of a profile.
Profilescreate_profileCreate a profile.
Profilesupdate_profileUpdate a profile.
Profilessubscribe_profile_to_marketingSubscribe a profile to marketing for a given channel and list.
Profilesunsubscribe_profile_from_marketingUnsubscribe a profile from marketing for a given channel and list.
Profilesget_bulk_import_profiles_jobGet the status of a bulk profile import job.
Profilesget_bulk_suppress_profiles_jobGet the status of a bulk profile suppression job.
Profilesget_bulk_unsuppress_profiles_jobGet the status of a bulk profile unsuppression job.
Profilesget_push_tokenGet details of a push token.
Profilesget_bulk_import_profiles_jobsList bulk profile import jobs.
Profilesget_bulk_suppress_profiles_jobsList bulk profile suppression jobs.
Profilesget_bulk_unsuppress_profiles_jobsList bulk profile unsuppression jobs.
Profilesget_push_tokensList push tokens.
Profilescreate_or_update_profileCreate or update a profile.
Profilescreate_push_tokenCreate or update a push token.
Profilesdelete_push_tokenDelete a push token.
Profilesbulk_import_profilesImport profiles in bulk.
Profilesbulk_suppress_profilesSuppress profiles from marketing in bulk.
Profilesbulk_unsuppress_profilesUnsuppress profiles in bulk.
Profilesmerge_profilesMerge two profiles.
Profilesget_download_for_profile_bulk_export_jobGet the download URL for a profile bulk export job. (Beta)
Profilesget_profile_bulk_export_jobGet the status of a profile bulk export job.
Reportingget_campaign_reportGet a report of your campaign performance.
Reportingget_flow_reportGet a report of your flow performance.
Reportingquery_form_valuesQuery form performance values.
Reportingquery_form_seriesQuery form performance over time.
Reportingquery_segment_valuesQuery segment membership values.
Reportingquery_segment_seriesQuery segment membership over time.
Templatescreate_email_templateCreate an HTML email template.
Templatesget_email_templateGet the details of an email template.
Templatescreate_dnd_email_templateCreate a drag-and-drop (DND) email template with a structured definition.
Templatesupdate_dnd_email_templateUpdate an existing drag-and-drop (DND) email template.
Templateslist_email_templatesList your email templates.
Templatesupdate_email_templateUpdate an HTML email template.
Templatesclone_email_templateClone an email template.
Templatesdelete_email_templateDelete an email template.
Templatesrender_email_templateRender an email template with provided context.
Templatesget_universal_contentGet details of a universal content block.
Templatesget_all_universal_contentList universal content blocks.
Templatescreate_universal_contentCreate a universal content block.
Templatesupdate_universal_contentUpdate a universal content block.
Templatesdelete_universal_contentDelete a universal content block.
Templatescreate_template_preview_send_jobSend a preview of a template to specified recipients. (Beta)
Translationsget_translationsList all translation collections. Supports filtering by channel, resource type, and resource ID. (Beta)
Translationsget_translationGet a translation collection by ID, optionally including translated values per locale. (Beta)
Translationscreate_translationCreate a translation collection for a campaign variation, flow message, template, or universal content. (Beta)
Translationsupdate_translationUpdate translation settings (locales) and/or import translated values for a resource. (Beta)
Translationsdelete_translationDelete a translation collection and all its localized values. (Beta)
Couponsget_couponGet details of a coupon.
Couponsget_bulk_create_coupon_codes_jobGet the status of a bulk coupon code create job.
Couponsget_couponsList coupons.
Couponsget_coupon_codesList coupon codes.
Couponsget_coupon_codeGet details of a coupon code.
Couponsget_bulk_create_coupon_code_jobsList bulk coupon code create jobs.
Couponscreate_couponCreate a coupon.
Couponsupdate_couponUpdate a coupon.
Couponscreate_coupon_codeCreate a coupon code.
Couponsupdate_coupon_codeUpdate a coupon code.
Couponsdelete_coupon_codeDelete a coupon code.
Couponsdelete_couponDelete a coupon.
Couponsbulk_create_coupon_codesCreate coupon codes in bulk.
Tagsget_tag_groupGet details of a tag group.
Tagsget_tagsList tags.
Tagsget_tagGet details of a tag.
Tagsget_tag_groupsList tag groups.
Tagscreate_tagCreate a tag.
Tagsupdate_tagUpdate a tag.
Tagsdelete_tagDelete a tag.
Tagscreate_tag_groupCreate a tag group.
Tagsupdate_tag_groupUpdate a tag group.
Tagsdelete_tag_groupDelete a tag group.
Tagstag_campaignsAdd a tag to campaigns.
Tagstag_flowsAdd a tag to flows.
Tagstag_listsAdd a tag to lists.
Tagstag_segmentsAdd a tag to segments.
Tagsremove_tag_from_campaignsRemove a tag from campaigns.
Tagsremove_tag_from_flowsRemove a tag from flows.
Tagsremove_tag_from_listsRemove a tag from lists.
Tagsremove_tag_from_segmentsRemove a tag from segments.
Webhooksget_webhookGet details of a webhook.
Webhooksget_webhook_topicsList webhook topics.
Webhooksget_webhook_topicGet details of a webhook topic.
Webhooksget_webhooksList webhooks.
Webhooksdelete_webhookDelete a webhook.
Formsget_formGet details of a form.
Formsget_formsList forms.
Formsget_form_versionGet details of a form version.
Formscreate_formCreate a form.
Formsdelete_formDelete a form.
Reviewsupdate_reviewUpdate a review.
Data Privacyrequest_profile_deletionRequest deletion of a profile's data.
Applicationsget_applicationsList OAuth applications. (Beta)
Billinglist_billing_usageList billing usage records. (Beta)
Billingget_billing_usageGet details of a billing usage record. (Beta)
Brandscreate_brand_buttonCreate a brand button. (Beta)
Brandscreate_brand_colorCreate a brand color. (Beta)
Brandscreate_brand_logoCreate a brand logo. (Beta)
Brandscreate_brand_social_groupCreate a brand social group. (Beta)
Brandsdelete_brand_buttonDelete a brand button. (Beta)
Brandsdelete_brand_colorDelete a brand color. (Beta)
Brandsdelete_brand_logoDelete a brand logo. (Beta)
Brandsdelete_brand_social_groupDelete a brand social group. (Beta)
Brandsget_brand_buttonGet details of a brand button. (Beta)
Brandsget_brand_buttonsList brand buttons. (Beta)
Brandsget_brand_colorGet details of a brand color. (Beta)
Brandsget_brand_colorsList brand colors. (Beta)
Brandsget_brand_email_defaultGet details of a brand email default. (Beta)
Brandsget_brand_email_defaultsList brand email defaults. (Beta)
Brandsget_brand_logoGet details of a brand logo. (Beta)
Brandsget_brand_logosList brand logos. (Beta)
Brandsget_brand_social_groupGet details of a brand social group. (Beta)
Brandsget_brand_social_groupsList brand social groups. (Beta)
Brandsget_brand_voiceGet the brand voice. (Beta)
Brandsupdate_brand_buttonUpdate a brand button. (Beta)
Brandsupdate_brand_colorUpdate a brand color. (Beta)
Brandsupdate_brand_email_defaultUpdate a brand email default. (Beta)
Brandsupdate_brand_logoUpdate a brand logo. (Beta)
Brandsupdate_brand_social_groupUpdate a brand social group. (Beta)
Brandsupdate_brand_voiceUpdate the brand voice. (Beta)
Customer Agentcreate_agent_knowledgeCreate an agent knowledge entry. (Beta)
Customer Agentcreate_agent_skillCreate an agent skill. (Beta)
Customer Agentcreate_agent_toolCreate an agent tool. (Beta)
Customer Agentcreate_customer_agent_responseCreate a customer agent response. (Beta)
Customer Agentdelete_agent_knowledgeDelete an agent knowledge entry. (Beta)
Customer Agentdelete_agent_skillDelete an agent skill. (Beta)
Customer Agentdelete_agent_toolDelete an agent tool. (Beta)
Customer Agentget_agent_knowledgeGet details of an agent knowledge entry. (Beta)
Customer Agentlist_agent_knowledgeList agent knowledge entries. (Beta)
Customer Agentget_agent_skillGet details of an agent skill. (Beta)
Customer Agentget_agent_skillsList agent skills. (Beta)
Customer Agentget_agent_toolGet details of an agent tool. (Beta)
Customer Agentget_agent_toolsList agent tools. (Beta)
Customer Agentget_customer_agentGet details of a customer agent. (Beta)
Customer Agentretrieve_customer_agent_conversationGet details of a customer agent conversation. (Beta)
Customer Agentlist_customer_agent_conversationsList customer agent conversations. (Beta)
Customer Agentget_agent_messages_for_customer_agent_conversationList messages in a customer agent conversation. (Beta)
Customer Agentget_skills_for_agent_toolList the skills for an agent tool. (Beta)
Customer Agentquery_customer_agent_skill_valuesQuery customer agent skill values. (Beta)
Customer Agentquery_customer_agent_valuesQuery customer agent values. (Beta)
Customer Agentupdate_agent_knowledgeUpdate an agent knowledge entry. (Beta)
Customer Agentupdate_agent_skillUpdate an agent skill. (Beta)
Customer Agentupdate_agent_toolUpdate an agent tool. (Beta)
Customer Agentupdate_customer_agentUpdate a customer agent. (Beta)
Customer Agentupdate_customer_agent_conversationUpdate a customer agent conversation. (Beta)
Sending Domainscreate_sending_domain_activation_jobCreate a sending domain activation job. (Beta)
Sending Domainscreate_sending_domainCreate a sending domain. (Beta)
Sending Domainsdelete_sending_domainDelete a sending domain. (Beta)
Sending Domainsget_sending_domainGet details of a sending domain. (Beta)
Sending Domainsget_sending_domainsList sending domains. (Beta)
Sending Domainscreate_sending_domain_verification_jobCreate a sending domain verification job. (Beta)
Text Messagingcreate_text_messaging_configurationCreate a text messaging configuration. (Beta)
Text Messagingcreate_text_messaging_senderCreate a text messaging sender. (Beta)
Text Messagingcreate_text_messaging_sender_registrationCreate a text messaging sender registration. (Beta)
Text Messagingget_messaging_sender_registration_id_for_text_messaging_senderGet the registration ID for a text messaging sender. (Beta)
Text Messagingget_text_messaging_configurationGet details of a text messaging configuration. (Beta)
Text Messagingget_text_messaging_senderGet details of a text messaging sender. (Beta)
Text Messagingget_text_messaging_sender_registrationGet details of a text messaging sender registration. (Beta)
Text Messagingget_text_messaging_sendersList text messaging senders. (Beta)

Did this page help you?