Integration · Email

Connect Claude & ChatGPT to OptiPub

Ask your AI how yesterday's newsletter performed, which emails a subscriber has received, or how many people are in a segment. It can read publications, messages, campaigns, auto-responders and transactions, manage subscribers, subscriptions and segments, and create, schedule or cancel email and SMS messages.

Connect OptiPub free

Free plan, no credit card. Takes about a minute.

Try asking

“How did yesterday's newsletter perform?”
The AI finds the message by send date and reads its delivery, open, click and sales statistics.
“Which emails has [email protected] received from us?”
It lists the messages sent to that subscriber, optionally for one publication.
“Subscribe [email protected] to the Daily Brief with the tag webinar.”
It finds the publication and creates the subscription with the tag.

What your AI can do

Messages and stats

List and read email and SMS messages, see delivery, open, click and sales stats, and create, schedule or cancel messages.

Subscribers and segments

Look up subscribers and their history, manage subscriptions and tags, and add or remove people from segments.

Publications, campaigns and billing

Read publications, campaigns, auto-responders and billing transactions, and send an auto-responder as a transactional email.

“How many subscribers are in the Lapsed buyers segment?”
It finds the segment and returns its subscriber counts.
“Move tomorrow's promo email to 9:00.”
It finds the message and sets the new send time. The message goes out to its recipients at that time.
“Show declined transactions from last week.”
It lists billing transactions in that date range that were declined, with customer email and publication.

392 tools for OptiPub

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

add_subscriber_to_segmentChanges dataAdd a subscriber by `email` to a static segment (`segment`), with optional variables.
approve_ai_billing_termVisible to othersApprove a ai billing term. Has effects visible outside this system. API summary: Accept AI billing terms.
approve_draftDeletesApprove a draft (translation). Destructive action; may require approval. API summary: Approve Resource Translation Draft.
archive_quoteVisible to othersArchive a quote (everflow affiliate offer id). Has effects visible outside this system. API summary: Archive Everflow Affiliate Offer.
cancel_messageDeletesCancel a scheduled message by `message_id` so it is not sent.
create_adChanges dataCreate a new ad. Required: active, name, content, ad category id, publication id or user id. Search ads first to avoid duplicates. API summary: Create Text Ad.
create_ad_categoryChanges dataCreate a new category. Required: name. Search categories first to avoid duplicates. API summary: Create Ad Category.
create_addressChanges dataCreate a new address. Required: ip. API summary: Create IP Address.
create_asset_draftChanges dataCreate a new asset draft. Required: prompt. API summary: Generate AI Image Draft.
create_asset_draft_applyChanges dataCreate a new apply for a asset draft. API summary: Apply AI Image Draft.
create_asset_editChanges dataCreate a new edit for a asset. Required: prompt. API summary: Edit Asset with AI.
create_authorChanges dataCreate a new author. Required: active, display name, group id, show on website, user id or publication id. API summary: Create Author.
create_author_categoryChanges dataCreate a new category. Required: name. Search categories first to avoid duplicates. API summary: Create Author Category.
create_auto_responderChanges dataCreate a new auto responder. Required: name, content, subject, auto responder category id, publication id or default. Search auto responders first to avoid duplicates. API summary: Create Auto Responder.
create_auto_responder_categoryChanges dataCreate a new category. Required: name, auto responder category type id, has default or has single default. Search categories first to avoid duplicates. API summary: Create Auto Responder Category.
create_auto_responder_translationChanges dataCreate a new translation for a auto responder. Required: locales. API summary: Create Auto Responder Translation.
create_auto_responder_variationChanges dataCreate a new auto responder variation. Required: active, content, auto responder id or subject. Search auto responder variations first to avoid duplicates. API summary: Create Auto Responder Variant.
create_blocklistChanges dataCreate a new blocklist. Required: urls. API summary: Start Blocklist Scan.
create_bulk_actionVisible to othersCreate a new bulk action. Required: advanced query or bulk action type. Has effects visible outside this system. API summary: Execute Bulk Action.
create_calendar_eventChanges dataCreate a new calendar event. Required: name, start date time, publication id or calendar event category id. Search calendar events first to avoid duplicates. API summary: Create Calendar Event.
create_campaignChanges dataCreate a new campaign. Required: name, active, partner id or publication id. Search campaigns first to avoid duplicates. API summary: Create Campaign.
create_campaign_generate_linkChanges dataCreate a new generate link for a campaign. Required: name, effort type id or partner id. API summary: Generate Campaign Link.
create_campaign_lift_letterChanges dataCreate a new lift letter for a campaign. Required: title, author id or source. API summary: Create Campaign Lift Letter.
create_campaign_manage_utmChanges dataCreate a new manage utm for a campaign. API summary: Update Campaign UTM Settings.
create_categoryChanges dataCreate a new category. Required: name. Search categories first to avoid duplicates. API summary: Create Calendar Event Category.
create_completionChanges dataCreate a new completion. Required: prompt. API summary: Generate or rewrite content with AI.
create_custom_contentChanges dataCreate a new custom content. Required: name, content, custom content category id, available for all publications, macro or editor type. Search custom contents first to avoid duplicates. API summary: Create Custom Content.
create_custom_content_categoryChanges dataCreate a new category. Required: name. Search categories first to avoid duplicates. API summary: Create Custom Content Category.
create_detectChanges dataCreate a new detect. Required: prompt. API summary: Detect Market Data Needs In A Prompt.
create_domainChanges dataCreate a new domain. Required: domain. API summary: Create Domain.
create_effortChanges dataCreate a new effort. Required: name, active or partner id. Search efforts first to avoid duplicates. API summary: Create Effort.
create_faqChanges dataCreate a new faq. Required: active, question, answer or publication id. API summary: Create FAQ.
create_formChanges dataCreate a new form. Required: name, active, publication id or elements. Search forms first to avoid duplicates. API summary: Create Form.
create_funnelChanges dataCreate a new funnel. Required: name, publication id, active, stop on unsubscribe or data. Search funnels first to avoid duplicates. API summary: Create Funnel.
create_generateChanges dataCreate a new generate. Required: prompt. API summary: Generate Asset with AI.
create_google_tag_manager_containerChanges dataCreate a new google tag manager container. Required: name, type or container id. Search google tag manager containers first to avoid duplicates. API summary: Create GTM Container.
create_groupChanges dataCreate a new group. Required: name. Search groups first to avoid duplicates. API summary: Create Group.
create_landing_pageChanges dataCreate a new page. Required: landing page category type id, publication id, author id, browser title or active. Search pages first to avoid duplicates. API summary: Create Landing Page.
create_landing_page_categoryChanges dataCreate a new category. Required: name or landing page category type id. Search categories first to avoid duplicates. API summary: Create Landing Page Category.
create_messageVisible to othersCreate an email or SMS message: `publication_id`, `message_type_id`, `is_test`, plus subject, content or template_id, sender_id, segments and send_at. A message with send_at set goes out to subscribers at that time.
create_opt_inChanges dataCreate a new opt in. Required: email. API summary: Opt In Subscriber.
create_pageChanges dataCreate a new page. Required: domain id, page type id, html, path, active or publication id. Search pages first to avoid duplicates. API summary: Create Page.
create_page_categoryChanges dataCreate a new category. Required: name. Search categories first to avoid duplicates. API summary: Create Page Category.
create_page_translationChanges dataCreate a new translation for a page. Required: locales. API summary: Create Landing Page Translation.
create_partnerChanges dataCreate a new partner. Required: name, active or partner categories id. Search partners first to avoid duplicates. API summary: Create Partner.
create_partner_categoryChanges dataCreate a new category. Required: name. Search categories first to avoid duplicates. API summary: Create Partner Category.
create_partner_everflow_connectionChanges dataCreate a new everflow connection for a partner. API summary: Connect Partner Everflow Network.
create_pricing_planChanges dataCreate a new pricing plan. Required: active, name, hide option, publication id or options. Search pricing plans first to avoid duplicates. API summary: Create Pricing Plan.
create_pricing_plan_discountChanges dataCreate a new discount for a pricing plan. Required: name. API summary: Create Discounted Copy of Pricing Plan.
create_publicationChanges dataCreate a new publication. Required: name, active or binding id. Search publications first to avoid duplicates. API summary: Create Publication.
create_recipient_countChanges dataCreate a new recipient count. Required: included segment ids. API summary: Retrieve Segment Recipient Count.
create_record_unsubscribeChanges dataCreate a new record unsubscribe. Required: hash.
create_redirectChanges dataCreate a new redirect. Required: domain id, code, from, to or regex. API summary: Create Redirect.
create_resourceChanges dataCreate a new resource. Required: publication id, active, author id, meta description, resource category id or show on website. Search resources first to avoid duplicates. API summary: Create Resource.
create_resource_categoryChanges dataCreate a new category. Required: name, description or user ranks. Search categories first to avoid duplicates. API summary: Create Resource Category.
create_resource_translationChanges dataCreate a new translation for a resource. Required: locales. API summary: Create Resource Translation.
create_segmentChanges dataCreate a new segment. Required: name, description or publication id. Search segments first to avoid duplicates. API summary: Create Segment.
create_selectChanges dataCreate a new select. Required: segment id or included. API summary: Create Auto Selected Segment.
create_senderChanges dataCreate a new sender. Required: publication id, name, local part or domain id. Search senders first to avoid duplicates. API summary: Create Sender.
create_serviceChanges dataCreate a new service. Required: name or service sid. API summary: Create Messaging Service.
create_subject_lineChanges dataCreate a new subject line. API summary: Generate email subject line options with AI.
create_subscriber_variableVisible to othersCreate a new variable for a subscriber. Required: email id, variable id or value. Has effects visible outside this system. API summary: Set Subscriber Variable Value.
create_subscriptionChanges dataSubscribe someone to a publication: `publication_id` plus an email or subscriber_id, with optional tags, variables and effort_id (the marketing effort they came from).
create_subscription_addonChanges dataCreate a new addon for a subscription. Required: type or identifier. API summary: Create Subscription Addon.
create_tagChanges dataCreate a new tag. Required: name or color. Search tags first to avoid duplicates. API summary: Create Tag.
create_templateChanges dataCreate a new template. Required: name, content, template category id or available for all publications. Search templates first to avoid duplicates. API summary: Create Template.
create_template_categoryChanges dataCreate a new category. Required: name or template category type id. Search categories first to avoid duplicates. API summary: Create Template Category.
create_template_translationChanges dataCreate a new translation for a template. Required: locales. API summary: Create Template Translation.
create_test_listChanges dataCreate a new test list. Required: name or emails. API summary: Create Test List.
create_testimonialChanges dataCreate a new testimonial. Required: publication id, testimonial, name, email, active or date. Search testimonials first to avoid duplicates. API summary: Create Testimonial.
create_thumbnailChanges dataCreate a new thumbnail. Required: player or player data. API summary: Generate Video Thumbnails.
create_translation_retranslateChanges dataCreate a new retranslate for a translation. API summary: Retranslate Resource Translation.
create_translation_retranslate_retranslate_auto_responder_translChanges dataCreate a new retranslate for a translation. API summary: Retranslate Auto Responder Translation.
create_translation_retranslate_retranslate_landing_page_translatChanges dataCreate a new retranslate for a translation. API summary: Retranslate Landing Page Translation.
create_translation_retranslate_retranslate_template_translationChanges dataCreate a new retranslate for a translation. API summary: Retranslate Template Translation.
create_userChanges dataCreate a new user. Required: first name, last name, email, active, is internal or requires password change. Search users first to avoid duplicates. API summary: Create User.
create_variableChanges dataCreate a new variable. Required: name, tag or data type. API summary: Create Subscriber Variable.
create_videoChanges dataCreate a new video. Required: active, title, name, show on website, player or player data. API summary: Create Video.
create_webhookDeletesCreate a new webhook. Required: name. Search webhooks first to avoid duplicates. Destructive action; may require approval. API summary: Create Webhook.
create_webhook_history_retryDeletesCreate a new retry for a webhook history. Destructive action; may require approval. API summary: Retry Webhook History Entry.
delete_adDeletesPermanently delete a ad by ad id. Destructive action; may require approval. API summary: Delete Text Ad.
delete_ad_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete Ad Category.
delete_addressDeletesPermanently delete a address by address id. Destructive action; may require approval. API summary: Delete IP Address.
delete_assetDeletesPermanently delete a asset by asset id. Destructive action; may require approval. API summary: Delete Asset.
delete_asset_draftDeletesPermanently delete a asset draft by asset draft id. Destructive action; may require approval. API summary: Discard AI Image Draft.
delete_authorDeletesPermanently delete a author by author id. Destructive action; may require approval. API summary: Delete Author.
delete_auto_responder_translationDeletesPermanently delete a translation by translation. Destructive action; may require approval. API summary: Delete Auto Responder Translation.
delete_auto_responder_variationDeletesPermanently delete a auto responder variation by auto responder variation id. Destructive action; may require approval. API summary: Delete Auto Responder Variant.
delete_calendar_eventDeletesPermanently delete a calendar event by calendar event id. Destructive action; may require approval. API summary: Delete Calendar Event.
delete_campaignDeletesPermanently delete a campaign by campaign id. Destructive action; may require approval. API summary: Delete Campaign.
delete_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete Calendar Event Category.
delete_custom_contentDeletesPermanently delete a custom content by custom content id. Destructive action; may require approval. API summary: Delete Custom Content.
delete_domainDeletesPermanently delete a domain by domain id. Destructive action; may require approval. API summary: Delete Domain.
delete_effortDeletesPermanently delete a effort by effort id. Destructive action; may require approval. API summary: Delete Effort.
delete_faqDeletesPermanently delete a faq by faq id. Destructive action; may require approval. API summary: Delete FAQ.
delete_formDeletesPermanently delete a form by form id. Destructive action; may require approval. API summary: Delete Form.
delete_funnelDeletesPermanently delete a funnel by funnel id. Destructive action; may require approval. API summary: Delete Funnel.
delete_google_tag_manager_containerDeletesPermanently delete a google tag manager container by google tag manager container id. Destructive action; may require approval. API summary: Delete GTM Container.
delete_groupDeletesPermanently delete a group by group id. Destructive action; may require approval. API summary: Delete Group.
delete_landing_pageDeletesPermanently delete a page by page id. Destructive action; may require approval. API summary: Delete Landing Page.
delete_landing_page_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete Landing Page Category.
delete_opt_insMoves moneyPermanently delete a opt in. Financial or irreversible action; may require approval. API summary: Mark Subscriber Email Invalid.
delete_pageDeletesPermanently delete a page by page id. Destructive action; may require approval. API summary: Delete Page.
delete_page_translationDeletesPermanently delete a translation by translation. Destructive action; may require approval. API summary: Delete Landing Page Translation.
delete_partnerDeletesPermanently delete a partner by partner id. Destructive action; may require approval. API summary: Delete Partner.
delete_partner_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete Partner Category.
delete_partner_everflow_connectionsMoves moneyPermanently delete a everflow connection by partner id. Financial or irreversible action; may require approval. API summary: Remove Partner Everflow Affiliate Key.
delete_publicationDeletesPermanently delete a publication by publication id. Destructive action; may require approval. API summary: Delete Publication.
delete_redirectDeletesPermanently delete a redirect by redirect id. Destructive action; may require approval. API summary: Delete Redirect.
delete_resourceDeletesPermanently delete a resource by resource id. Destructive action; may require approval. API summary: Delete Resource.
delete_resource_translationDeletesPermanently delete a translation by translation. Destructive action; may require approval. API summary: Delete Resource Translation.
delete_segmentDeletesPermanently delete a segment by segment id. Destructive action; may require approval. API summary: Delete Segment.
delete_segmentsMoves moneyPermanently delete a segment. Financial or irreversible action; may require approval. API summary: Delete Segments (Bulk).
delete_selectDeletesPermanently delete a select by select id. Destructive action; may require approval. API summary: Delete Auto Selected Segment.
delete_serviceDeletesPermanently delete a service by service id. Destructive action; may require approval. API summary: Delete Messaging Service.
delete_subscriber_variableDeletesPermanently delete a variable by variable id. Destructive action; may require approval. API summary: Delete Subscriber Variable Value.
delete_subscriptionDeletesPermanently delete a subscription by subscription id. Destructive action; may require approval. API summary: Stop Subscription.
delete_subscription_addonDeletesPermanently delete a addon by addon. Destructive action; may require approval. API summary: Stop Subscription Addon.
delete_subscriptionsMoves moneyPermanently delete a subscription. Financial or irreversible action; may require approval. API summary: Stop Subscription by Email.
delete_template_translationDeletesPermanently delete a translation by translation. Destructive action; may require approval. API summary: Delete Template Translation.
delete_test_listDeletesPermanently delete a test list by test list id. Destructive action; may require approval. API summary: Delete Test List.
delete_testimonialDeletesPermanently delete a testimonial by testimonial id. Destructive action; may require approval. API summary: Delete Testimonial.
delete_translation_draftsMoves moneyPermanently delete a draft by translation. Financial or irreversible action; may require approval. API summary: Discard Resource Translation Draft.
delete_translation_drafts_discard_auto_responder_variation_transMoves moneyPermanently delete a draft by translation. Financial or irreversible action; may require approval. API summary: Discard Auto Responder Variant Translation Draft.
delete_translation_drafts_discard_landing_page_translation_draftMoves moneyPermanently delete a draft by translation. Financial or irreversible action; may require approval. API summary: Discard Landing Page Translation Draft.
delete_translation_drafts_discard_template_translation_draftMoves moneyPermanently delete a draft by translation. Financial or irreversible action; may require approval. API summary: Discard Template Translation Draft.
delete_variableDeletesPermanently delete a variable by variable id. Destructive action; may require approval. API summary: Delete Subscriber Variable.
delete_videoDeletesPermanently delete a video by video id. Destructive action; may require approval. API summary: Delete Video.
delete_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval. API summary: Delete Webhook.
download_reportDownload the document for a report. API summary: Download Message Report.
export_segmentChanges dataExport segments.
export_segmentsChanges dataExport segments.
get_adGet one ad by ad id. API summary: Retrieve Text Ad.
get_addressGet one address by address id. API summary: Retrieve IP Address.
get_authorGet one author by author id. API summary: Retrieve Author.
get_auto_responderGet one auto-responder by `auto_responder_id`.
get_auto_responder_variationGet one auto responder variation by auto responder variation id. API summary: Retrieve Auto Responder Variant.
get_bindingGet one binding by binding id. API summary: Retrieve Binding.
get_blocklistGet one blocklist by blocklist id. API summary: Get Blocklist Scan Status.
get_calendar_eventGet one calendar event by calendar event id. API summary: Retrieve Calendar Event.
get_campaignGet one marketing campaign by `campaign_id`.
get_categoryGet one category by category id. API summary: Retrieve Calendar Event Category.
get_changeGet one change by change id. API summary: Retrieve Change.
get_contentGet one content by content id. API summary: Retrieve Message Content.
get_custom_contentGet one custom content by custom content id. API summary: Retrieve Custom Content Snippet.
get_domainGet one domain by domain id. API summary: Retrieve Domain.
get_effortGet one effort by effort id. API summary: Retrieve Effort.
get_effort_typeGet one effort type by effort type id. API summary: Retrieve Effort Type.
get_faqGet one faq by faq id. API summary: Retrieve FAQ.
get_formGet one form by form id. API summary: Retrieve Form.
get_funnelGet one funnel by funnel id. API summary: Retrieve Funnel.
get_funnel_actionGet one funnel action by funnel action id. API summary: Retrieve Funnel Action.
get_google_tag_manager_containerGet one google tag manager container by google tag manager container id. API summary: Retrieve GTM Container.
get_groupGet one group by group id. API summary: Retrieve Group.
get_landing_page_category_typeGet one landing page category type by landing page category type id. API summary: Retrieve Landing Page Category Type.
get_messageGet one message by `message_id`, with its subject, content, schedule and status.
get_message_statsGet the delivery, open, click and sales statistics of a message by `message_id`.
get_pageGet one page by page id. API summary: Retrieve Page.
get_partnerGet one partner by partner id. API summary: Retrieve Partner.
get_previewGet one preview by preview id. API summary: Retrieve Page Preview.
get_pricing_planGet one pricing plan by pricing plan id. API summary: Retrieve Pricing Plan.
get_publicationGet one publication by `publication_id`.
get_quoteGet one quote by quote id. API summary: Retrieve Everflow Affiliate Offer.
get_redirectGet one redirect by redirect id. API summary: Retrieve Redirect.
get_resourceGet one resource by resource id. API summary: Retrieve Resource.
get_segmentGet one segment by `segment_id`.
get_segment_countsGet the subscriber counts of a segment by `segment_id`.
get_selectGet one select by select id. API summary: Retrieve Auto Selected Segment.
get_senderGet one sender by sender id. API summary: Retrieve Sender.
get_serviceGet one service by service id. API summary: Retrieve Messaging Service.
get_subscriberGet one subscriber by `subscriber_id`, with their profile, tags and addresses.
get_subscriptionGet one subscription by `subscription_id`.
get_tagGet one tag by tag id. API summary: Retrieve Tag.
get_taskGet one task by task id. API summary: Retrieve Task.
get_templateGet one template by template id. API summary: Retrieve Template.
get_test_listGet one test list by test list id. API summary: Retrieve Test List.
get_testimonialGet one testimonial by testimonial id. API summary: Retrieve Testimonial.
get_transactionGet one billing transaction by `payment_id`.
get_typeGet one type by type id. API summary: Retrieve Page Type.
get_userGet one user by user id. API summary: Retrieve User.
get_variableGet one variable by variable id. API summary: Retrieve Subscriber Variable.
get_videoGet one video by video id. API summary: Retrieve Video.
get_webhookGet one webhook by webhook id. API summary: Retrieve Webhook.
import_asset_from_urlChanges dataImport a asset. API summary: Import Asset from URL.
list_access_rulesList access rules. API summary: Retrieve Access Rules.
list_addressesList addresses. Optional filters: id, ip, monitoring status, rdns, created at or updated at. Results are paginated. API summary: Retrieve IP Addresses.
list_ai_prompt_layersList ai prompt layers. Optional filters: publication id or voice id. API summary: Preview AI Prompt Layers.
list_authorsList authors. Optional filters: id, active, display name, publication id, group id or user id. Results are paginated. API summary: Retrieve Authors.
list_auto_responder_bouncesList bounces for a auto responder. Optional filters: auto responder variation id or sort. Results are paginated. API summary: Retrieve Auto Responder Bounces.
list_auto_responder_clicksList clicks for a auto responder. Optional filters: auto responder variation id or sort. Results are paginated. API summary: Retrieve Auto Responder Clicks.
list_auto_responder_complaintsList complaints for a auto responder. Optional filters: auto responder variation id or sort. Results are paginated. API summary: Retrieve Auto Responder Complaints.
list_auto_responder_opensList opens for a auto responder. Optional filters: auto responder variation id or sort. Results are paginated. API summary: Retrieve Auto Responder Opens.
list_auto_responder_referencesList references for a auto responder. API summary: Retrieve Auto Responder References.
list_auto_responder_statisticsList statistics for a auto responder. Optional filters: auto responder variation id, date range or sections. API summary: Retrieve Auto Responder Statistics.
list_auto_responder_translationsList translations for a auto responder. API summary: Retrieve Auto Responder Translations.
list_auto_responder_unsubscriptionsList unsubscriptions for a auto responder. Optional filters: auto responder variation id or sort. Results are paginated. API summary: Retrieve Auto Responder Unsubscriptions.
list_auto_respondersList auto-responders (automated and transactional emails), filtered by name, publication, campaign or active status.
list_auto_responders_unsubscribesList auto responders. Optional filters: auto responder variation id or sort. Results are paginated. API summary: Retrieve Auto Responder List-Unsubscribes.
list_availablesList availables. API summary: Retrieve Available Locales.
list_business_infosList business infos. API summary: Retrieve Business Info.
list_campaign_languagesList languages for a campaign. Optional filters: promo id, order page id, advertorial id, lift id, exit intent promo id or exit intent order page id. API summary: Retrieve Campaign Languages.
list_campaignsList marketing campaigns, filtered by name, publication, partner or active status.
list_categoriesList categories. Optional filters: id with name, columns or sort. Results are paginated. API summary: Retrieve Auto Responder Categories.
list_change_relatedList related for a change. API summary: Retrieve Related Changes.
list_configurationsList configurations. API summary: Check Postmaster+ Configuration.
list_contentsList contents. Optional filters: message type id, publication id or promoted publication id. API summary: Retrieve Message Contents.
list_countsList counts. Optional filters: ids or type. API summary: Retrieve Segment Counts.
list_dailiesList dailies. Optional filters: metric, dimension, date range, date from, date to or advanced query. API summary: Retrieve Subscription Statistics (Daily).
list_discord_rolesList discord roles. API summary: Retrieve Discord Roles.
list_domainsList domains. Optional filters: id, domain, bounce domain, unsub domain, track domain or monitoring status. Results are paginated. API summary: Retrieve Domains.
list_faqsList faqs. Optional filters: id, active, question, answer, publication id or show on website. Results are paginated. API summary: Retrieve FAQs.
list_form_responsesList responses for a form. Optional filters: sort. Results are paginated. API summary: Retrieve Form Responses.
list_funnel_action_historiesList funnel action histories. Optional filters: id, funnel action id, funnel id, subscriber id, subscription subscriber id or subscriber email. Results are paginated. API summary: Retrieve Funnel Action History.
list_keysList keys. API summary: List Statistic Keys.
list_lift_letter_contentsList contents for a lift letter. Optional filters: publication id. API summary: Retrieve Campaign Lift Letter Content.
list_localesList locales. API summary: Retrieve Locales.
list_macrosList macros. Optional filters: types, custom category id, available for all publications, publication ids or sort. Results are paginated. API summary: Retrieve Macros.
list_market_dataList market data. Optional filters: symbols or range. API summary: Preview Market Data For AI Prompts.
list_message_bouncesList bounces for a message. Optional filters: sort. Results are paginated. API summary: Retrieve Message Bounces.
list_message_clicksList clicks for a message. Optional filters: sort. Results are paginated. API summary: Retrieve Message Clicks.
list_message_complaintsList complaints for a message. Optional filters: sort. Results are paginated. API summary: Retrieve Message Complaints.
list_message_linksList links for a message. API summary: Retrieve Message Links.
list_message_opensList opens for a message. Optional filters: sort. Results are paginated. API summary: Retrieve Message Opens.
list_message_salesList sales for a message. API summary: Retrieve Message Sales.
list_message_shipmentsList shipments for a message. Optional filters: sort. Results are paginated. API summary: Retrieve SMS Message Deliveries.
list_message_sms_clicksList sms clicks for a message. Optional filters: sort. Results are paginated. API summary: Retrieve SMS Message Clicks.
list_message_sms_failuresList sms failures for a message. Optional filters: sort. Results are paginated. API summary: Retrieve SMS Message Failures.
list_message_sms_opt_outsList sms opt outs for a message. Optional filters: sort. Results are paginated. API summary: Retrieve SMS Message Opt-outs (heuristic).
list_message_unsubscriptionsList unsubscriptions for a message. Optional filters: sort. Results are paginated. API summary: Retrieve Message Unsubscriptions.
list_messagesList email and SMS messages, filtered by publication, message type, send date or test flag.
list_messages_unsubscribesList messages. Optional filters: sort. Results are paginated. API summary: Retrieve Message List-Unsubscribes.
list_optipub_networksList optipub networks. API summary: Get OptiPub Network Listing.
list_page_translationsList translations for a page. API summary: Retrieve Landing Page Translations.
list_productsList products. Optional filters: exclude pricing plan id. API summary: Retrieve Used SamCart Product IDs.
list_publicationsList publications (newsletters and products), filtered by name, active status or tag. Use it to find a publication ID.
list_redirectsList redirects. Optional filters: id, domain id, code, from, to or created at. Results are paginated. API summary: Retrieve Redirects.
list_resource_translationsList translations for a resource. API summary: Retrieve Resource Translations.
list_schemasList schemas. Optional filters: type. API summary: Retrieve AI Helper Schema.
list_segment_historiesList histories for a segment. API summary: Retrieve Segment History.
list_segmentsList subscriber segments, filtered by name, publication or subscriber.
list_selectsList selects. Optional filters: message type id, publication id, promoted publication id or renewal type. API summary: Retrieve Segment Selects.
list_seriesList series. Optional filters: model, primary key, date range, date from, date to or interval. Results are paginated. API summary: Statistic Time Series.
list_servicesList services. API summary: Retrieve Messaging Services.
list_showsList shows. Optional filters: type or macro. API summary: Retrieve Macro.
list_statisticsList statistics. Optional filters: start stats at. API summary: Retrieve Message Statistics (Time Series).
list_statsList stats. Optional filters: subscriber id, publication id or transaction type. API summary: Retrieve Transaction Statistics.
list_subscriber_emailsList the messages sent to a subscriber, by `subscriber_or_email` (subscriber ID or email), optionally for one publication.
list_subscriber_subscription_historyList the subscription history (sign-ups and changes) of a subscriber by `subscriber_id`.
list_subscriptionsList subscriptions, filtered by publication_id, active status, sign-up date, or open and click activity.
list_tagsList tags, filtered by name or color. Use tag IDs or names when tagging subscribers.
list_tasksList tasks. Optional filters: running or recently completed. API summary: Retrieve Tasks.
list_template_translationsList translations for a template. API summary: Retrieve Template Translations.
list_test_listsList test lists. API summary: Retrieve Test Lists.
list_transactionsList billing transactions, filtered by customer email, publication, type, date or declined status.
list_translation_draftsList drafts for a translation. API summary: Retrieve Resource Translation Draft.
list_typesList types. API summary: Retrieve Page Types.
list_usersList users. API summary: List OptiPub Network Members.
list_variablesList variables. Optional filters: sort. Results are paginated. API summary: Retrieve Subscriber Variables.
list_videosList videos. Optional filters: id, active, title, publication id, player or show on website. Results are paginated. API summary: Retrieve Videos.
list_webhook_historiesList webhook histories. Optional filters: webhook, data, created at or sort. Results are paginated. API summary: Retrieve Webhook History.
list_wistiaList wistia. API summary: Retrieve Wistia Videos.
list_wistia_settingsList wistia settings. API summary: Retrieve Wistia Settings.
pay_quote_tiersMoves moneyPayout a quote. Financial or irreversible action; may require approval. API summary: Retrieve Everflow Affiliate Offer Payout Tiers.
remove_subscriber_from_segmentDeletesRemove a subscriber by `email` from a segment (`segment`).
remove_subscriber_from_segment_with_statusDeletesPermanently delete a subscriber by active status. Destructive action; may require approval. API summary: Remove Subscriber From Segment With Status.
restore_quoteChanges dataUnarchive a quote (everflow affiliate offer id). API summary: Unarchive Everflow Affiliate Offer.
retrieve_ad_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Ad Categories.
retrieve_ad_categoryGet one category by category id. API summary: Retrieve Ad Category.
retrieve_author_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Author Categories.
retrieve_author_categoryGet one category by category id. API summary: Retrieve Author Category.
retrieve_auto_responder_categoryGet one category by category id. API summary: Retrieve Auto Responder Category.
retrieve_auto_responder_category_typeGet one type by type id. API summary: Retrieve Auto Responder Category Type.
retrieve_auto_responder_category_typesList types. API summary: Retrieve Auto Responder Category Types.
retrieve_auto_responder_variant_translation_draftList drafts for a translation. API summary: Retrieve Auto Responder Variant Translation Draft.
retrieve_auto_selected_segmentsList selects. Optional filters: id, segment id, included, created at, updated at or columns. Results are paginated. API summary: Retrieve Auto Selected Segments.
retrieve_custom_content_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Custom Content Categories.
retrieve_custom_content_categoryGet one category by category id. API summary: Retrieve Custom Content Category.
retrieve_landing_pageGet one page by page id. API summary: Retrieve Landing Page.
retrieve_landing_page_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Landing Page Categories.
retrieve_landing_page_categoryGet one category by category id. API summary: Retrieve Landing Page Category.
retrieve_landing_page_translation_draftList drafts for a translation. API summary: Retrieve Landing Page Translation Draft.
retrieve_landing_pagesSearch pages by id, active, name, publication id, landing page category id or landing page category type id. Use this to find existing pages before creating a new page. Results are paginated. API summary: Retrieve Landing Pages.
retrieve_message_typeGet one type by type id. API summary: Retrieve Message Type.
retrieve_page_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Page Categories.
retrieve_page_categoryGet one category by category id. API summary: Retrieve Page Category.
retrieve_partner_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Partner Categories.
retrieve_partner_categoryGet one category by category id. API summary: Retrieve Partner Category.
retrieve_resource_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Resource Categories.
retrieve_resource_categoryGet one category by category id. API summary: Retrieve Resource Category.
retrieve_subscription_statistics_aggregatedList statistics. Optional filters: dimension, date range, date from, date to, advanced query or campaign filters. API summary: Retrieve Subscription Statistics (Aggregated).
retrieve_template_categoriesList categories. Optional filters: columns or sort. Results are paginated. API summary: Retrieve Template Categories.
retrieve_template_categoryGet one category by category id. API summary: Retrieve Template Category.
retrieve_template_category_typeGet one type by type id. API summary: Retrieve Template Category Type.
retrieve_template_category_typesList types. Optional filters: columns or sort. Results are paginated. API summary: Retrieve Template Category Types.
retrieve_template_translation_draftList drafts for a translation. API summary: Retrieve Template Translation Draft.
retrieve_used_thrivecart_product_idsList products. Optional filters: exclude pricing plan id. API summary: Retrieve Used ThriveCart Product IDs.
schedule_messageDeletesSet or change when a message is sent: `message_id` and `send_at`. The message is sent to its recipients at that time.
search_adsSearch ads by id, active, name, description, publication id or user id. Use this to find existing ads before creating a new ad. Results are paginated. API summary: Retrieve Text Ads.
search_assetsSearch assets by id, keywords, types, tag id, created at or updated at. Use this to find existing assets before creating a new asset. Results are paginated. API summary: Retrieve Assets.
search_auto_responder_variationsSearch auto responder variations by auto responder id, id, provider template id, active, is control or draft. Use this to find existing auto responder variations before creating a new auto responder variation. Results are paginated. API summary: Retrieve Auto Responder Variants.
search_bindingsSearch bindings by id, name, created at, updated at or sort. Use this to find existing bindings before creating a new binding. Results are paginated. API summary: Retrieve Bindings.
search_calendar_eventsSearch calendar events by id, name, description, publication id, calendar event category id or start date time. Use this to find existing calendar events before creating a new calendar event. Results are paginated. API summary: Retrieve Calendar Events.
search_campaign_groupsSearch campaign groups by group by, search or exclude id. Use this to find existing campaign groups before creating a new campaign group. API summary: Retrieve Campaign Groups.
search_categoriesSearch categories by id, name, created at, updated at, id with name or columns. Use this to find existing categories before creating a new category. Results are paginated. API summary: Retrieve Calendar Event Categories.
search_custom_contentsSearch custom contents by id, name, macro, available for all publications, publication id or category id. Use this to find existing custom contents before creating a new custom content. Results are paginated. API summary: Retrieve Custom Content.
search_effort_typesSearch effort types by id, code, name, type, is renewal or is upsell. Use this to find existing effort types before creating a new effort type. Results are paginated. API summary: Retrieve Effort Types.
search_effortsSearch efforts by id, active, name, campaign id, publication id or partner id. Use this to find existing efforts before creating a new effort. Results are paginated. API summary: Retrieve Efforts.
search_formsSearch forms by id, name, active, email, created at or updated at. Use this to find existing forms before creating a new form. Results are paginated. API summary: Retrieve Forms.
search_funnelsSearch funnels by id, active, name, publication id, stop on unsubscribe or tag id. Use this to find existing funnels before creating a new funnel. Results are paginated. API summary: Retrieve Funnels.
search_google_tag_manager_containersSearch google tag manager containers by id, name, type, container id, publication id or created at. Use this to find existing google tag manager containers before creating a new google tag manager container. Results are paginated. API summary: Retrieve GTM Containers.
search_groupsSearch groups by id, name, two factor enabled, created at, updated at or columns. Use this to find existing groups before creating a new group. Results are paginated. API summary: Retrieve Groups.
search_landing_page_category_typesSearch landing page category types by id, name, columns or sort. Use this to find existing landing page category types before creating a new landing page category type. Results are paginated. API summary: Retrieve Landing Page Category Types.
search_pagesSearch pages by id, active, path, publication id, domain id or page type id. Use this to find existing pages before creating a new page. Results are paginated. API summary: Retrieve Pages.
search_partnersSearch partners by id, name, active, contact name, contact email or partner categories id. Use this to find existing partners before creating a new partner. Results are paginated. API summary: Retrieve Partners.
search_pricing_plansSearch pricing plans by id, active, name, publication id, tag id or id with name. Use this to find existing pricing plans before creating a new pricing plan. Results are paginated. API summary: Retrieve Pricing Plans.
search_quotesSearch quotes by partner id, offer affiliate status, approved, search, payout tier or archived. Use this to find existing quotes before creating a new quote. Results are paginated. API summary: Retrieve Everflow Affiliate Offers.
search_resourcesSearch resources by id, active, title, publication id, resource category id or author id. Use this to find existing resources before creating a new resource. Results are paginated. API summary: Retrieve Resources.
search_sendersSearch senders by id, name, local part, publication id, domain id or default. Use this to find existing senders before creating a new sender. Results are paginated. API summary: Retrieve Senders.
search_templatesSearch templates by id, name, template category id, available for all publications, publication id or message type id. Use this to find existing templates before creating a new template. Results are paginated. API summary: Retrieve Templates.
search_testimonialsSearch testimonials by id, active, name, email, publication id or tag id. Use this to find existing testimonials before creating a new testimonial. Results are paginated. API summary: Retrieve Testimonials.
search_typesSearch types by id, name, active, columns or sort. Use this to find existing types before creating a new type. Results are paginated. API summary: Retrieve Message Types.
search_usersSearch users by id, first name, last name, email, active or is internal. Use this to find existing users before creating a new user. Results are paginated. API summary: Retrieve Users.
search_webhooksSearch webhooks by id, name, created at, updated at or sort. Use this to find existing webhooks before creating a new webhook. Results are paginated. API summary: Retrieve Webhooks.
send_auth_codeVisible to othersSend a auth code. Has effects visible outside this system. API summary: Send Two-Factor Auth Code.
send_html_transactionalVisible to othersSend a transactional. Has effects visible outside this system. API summary: Send HTML Transactional.
send_transactional_emailVisible to othersSend an auto-responder as a transactional email to one `email` address: `auto_responder_id` plus optional variables. Sends an email immediately.
submit_auth_codeVisible to othersValidate a auth code. Has effects visible outside this system. API summary: Validate Two-Factor Auth Code.
submit_domainVisible to othersRefresh a domain (domain id). Has effects visible outside this system. API summary: Refresh Domain.
submit_pageVisible to othersPreview a page. Has effects visible outside this system. API summary: Create Page Preview.
submit_segmentVisible to othersRefresh a segment (segment id). Has effects visible outside this system. API summary: Refresh Dynamic Segment.
submit_segment_splitVisible to othersSplit a segment (segment id). Has effects visible outside this system. API summary: Split Segment.
submit_segment_verifyVisible to othersVerify a segment (segment id). Has effects visible outside this system. API summary: Verify Segment Emails.
submit_tagVisible to othersMerge a tag (tag id). Has effects visible outside this system. API summary: Merge Tags.
submit_translationVisible to othersSync a translation (translation). Has effects visible outside this system. API summary: Update Resource Translation From Source.
update_adChanges dataUpdate an existing ad identified by ad id. API summary: Update Text Ad.
update_ad_categoryChanges dataUpdate an existing category identified by category id. API summary: Update Ad Category.
update_addressChanges dataUpdate an existing address identified by address id. API summary: Update IP Address.
update_assetChanges dataUpdate an existing asset identified by asset id. API summary: Update Asset.
update_authorChanges dataUpdate an existing author identified by author id. API summary: Update Author.
update_author_categoryChanges dataUpdate an existing category identified by category id. API summary: Update Author Category.
update_auto_responderChanges dataUpdate an existing auto responder identified by auto responder id. API summary: Update Auto Responder.
update_auto_responder_translation_from_sourceVisible to othersSync a translation (translation). Has effects visible outside this system. API summary: Update Auto Responder Translation From Source.
update_auto_responder_variant_translation_from_sourceVisible to othersSync a translation (translation). Has effects visible outside this system. API summary: Update Auto Responder Variant Translation From Source.
update_auto_responder_variationChanges dataUpdate an existing auto responder variation identified by auto responder variation id. API summary: Update Auto Responder Variant.
update_bindingChanges dataUpdate an existing binding identified by binding id. API summary: Update Binding.
update_calendar_eventChanges dataUpdate an existing calendar event identified by calendar event id. API summary: Update Calendar Event.
update_campaignChanges dataUpdate an existing campaign identified by campaign id. API summary: Update Campaign.
update_categoryChanges dataUpdate an existing category identified by category id. API summary: Update Calendar Event Category.
update_custom_contentChanges dataUpdate an existing custom content identified by custom content id. API summary: Update Custom Content.
update_domainChanges dataUpdate an existing domain identified by domain id. API summary: Update Domain.
update_effortChanges dataUpdate an existing effort identified by effort id. API summary: Update Effort.
update_faqChanges dataUpdate an existing faq identified by faq id. API summary: Update FAQ.
update_formChanges dataUpdate an existing form identified by form id. API summary: Update Form.
update_funnelChanges dataUpdate an existing funnel identified by funnel id. API summary: Update Funnel.
update_funnel_addVisible to othersUpdate an existing add identified by subscriber or email. Has effects visible outside this system. API summary: Add Subscriber to Funnel.
update_google_tag_manager_containerChanges dataUpdate an existing google tag manager container identified by google tag manager container id. API summary: Update GTM Container.
update_groupChanges dataUpdate an existing group identified by group id. API summary: Update Group.
update_group_permissionsMoves moneyUpdate an existing permission identified by group id. Financial or irreversible action; may require approval. API summary: Update Group Permissions.
update_landing_pageChanges dataUpdate an existing page identified by page id. API summary: Update Landing Page.
update_landing_page_categoryChanges dataUpdate an existing category identified by category id. API summary: Update Landing Page Category.
update_landing_page_translation_from_sourceVisible to othersSync a translation (translation). Has effects visible outside this system. API summary: Update Landing Page Translation From Source.
update_messageVisible to othersUpdate an existing message identified by message id. Has effects visible outside this system. API summary: Update Message.
update_message_segmentsDeletesUpdate an existing segment identified by message id. Destructive action; may require approval. API summary: Update Message Segments.
update_message_triggered_sendsDeletesUpdate an existing triggered send identified by message id. Destructive action; may require approval. API summary: Update Message Triggered Send.
update_optipub_networksVisible to othersUpdate an existing optipub network. Has effects visible outside this system. API summary: Update OptiPub Network Listing.
update_pageChanges dataUpdate an existing page identified by page id. API summary: Update Page.
update_partnerChanges dataUpdate an existing partner identified by partner id. API summary: Update Partner.
update_partner_categoryChanges dataUpdate an existing category identified by category id. API summary: Update Partner Category.
update_pricing_planChanges dataUpdate an existing pricing plan identified by pricing plan id. API summary: Update Pricing Plan.
update_publicationChanges dataUpdate an existing publication identified by publication id. API summary: Update Publication.
update_redirectChanges dataUpdate an existing redirect identified by redirect id. API summary: Update Redirect.
update_resourceChanges dataUpdate an existing resource identified by resource id. API summary: Update Resource.
update_segmentChanges dataUpdate an existing segment identified by segment id. API summary: Update Segment.
update_senderChanges dataUpdate an existing sender identified by sender id. API summary: Update Sender.
update_serviceChanges dataUpdate an existing service identified by service id. API summary: Update Messaging Service.
update_subscriberChanges dataUpdate a subscriber by `subscriber_id`: locale, timezone, billing or shipping address, or tags (tag_ids, add_tags_by_name, remove_tags_by_name). Only the fields you pass change.
update_subscriber_variableVisible to othersUpdate an existing variable identified by variable id. Has effects visible outside this system. API summary: Update Subscriber Variable Value.
update_subscriptionChanges dataUpdate a subscription by `subscription_id`: set active to false to unsubscribe, change the email, tags or variables.
update_subscription_addonChanges dataUpdate an existing addon identified by addon. API summary: Update Subscription Addon.
update_tagChanges dataUpdate an existing tag identified by tag id. API summary: Update Tag.
update_templateChanges dataUpdate an existing template identified by template id. API summary: Update Template.
update_template_translation_from_sourceVisible to othersSync a translation (translation). Has effects visible outside this system. API summary: Update Template Translation From Source.
update_test_listChanges dataUpdate an existing test list identified by test list id. API summary: Update Test List.
update_testimonialChanges dataUpdate an existing testimonial identified by testimonial id. API summary: Update Testimonial.
update_toggle_activeChanges dataUpdate an existing toggle active identified by toggle active id. API summary: Toggle Auto Responder Variant Active.
update_userChanges dataUpdate an existing user identified by user id. API summary: Update User.
update_user_permissionsMoves moneyUpdate an existing permission identified by user id. Financial or irreversible action; may require approval. API summary: Update User Permissions.
update_variableChanges dataUpdate an existing variable identified by variable id. API summary: Update Subscriber Variable.
update_videoChanges dataUpdate an existing video identified by video id. API summary: Update Video.
upload_assetChanges dataUpload a asset. API summary: Upload Asset.
upload_everflow_creativeChanges dataUpload a everflow creative (campaign id). API summary: Import Everflow Creatives.
upload_wistiumChanges dataUpload a wistium. API summary: Upload Video to Wistia.

Set up in three steps

1
Pick the app
Create a free HeyMyApps account and choose OptiPub from the app list.
2
Paste your key
Enter your OptiPub app domain (for example yourapp.app.optipub.com) and an API key. In OptiPub go to Settings → API Keys, click Create API Key, name it and save. Copy the key right away, it is shown only once.
3
Add the link to your AI
You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:
1. Click your name, then Settings › Connectors › Add custom connector.
2. Paste your link as the Remote MCP server URL.
3. Switch it on from the + menu in a chat.

Questions

What can the AI do in OptiPub?

The AI can read publications, messages and their stats, subscribers, subscriptions, segments, tags, campaigns, auto-responders and billing transactions. It can create subscriptions, update subscribers and subscriptions, add and remove segment members, create, schedule and cancel messages, and send transactional emails.

Does the AI see my OptiPub credentials?

No. Your OptiPub credentials are encrypted at rest and never shown to the AI. After you save them, they are not shown again, not even to you. The AI only sees the results of the tools it calls.

Can I control what the AI is allowed to do?

Yes. You choose which tools are switched on, so you can start with lookups only. Creating or scheduling a message sends it to subscribers at the set time, a transactional email goes out at once, and cancelling a message or removing someone from a segment changes what people receive. These can require your approval before they run. Every tool call is logged.

Does it work with ChatGPT?

Yes. In ChatGPT go to Settings › Apps & Connectors › Advanced and turn on Developer mode, then add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.

What does it cost?

HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own OptiPub account.

What permissions does the OptiPub API key have?

An OptiPub API key has the permissions of the user who created it. Create it with a user whose access you are comfortable giving the AI, then switch on only the tools you want in HeyMyApps.