Iterable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Iterable Web Push API

4 actions 4 updates phrasing extends openapi/iterable-web-push-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Iterable's API. It is a proposal applied on top of the contract, not a document Iterable publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/webPush/cancel'].post
$.paths['/api/webPush/target'].post
$.paths['/webPush/target'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Web Push API
  version: 1.0.0
extends: openapi/iterable-web-push-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/webPush/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a web push to a user
      effect: destructive
      questions:
      - Can I cancel a browser push scheduled for one user?
      - What do I need to identify a web push I want to cancel?
      instructions:
      - text: Cancel the web push from campaign {campaignId} to {email}.
        slots:
          campaignId: requestBody.campaignId
          email: requestBody.email
      - text: Cancel scheduled web push {scheduledMessageId}.
        slots:
          scheduledMessageId: requestBody.scheduledMessageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webPush/target'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a campaign web push to a user
      effect: write
      questions:
      - Can I schedule a browser push to one user for later?
      - Do request data fields override the user's profile in a web push?
      instructions:
      - text: Send web push campaign {campaignId} to {recipientEmail}.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
      - text: Send web push campaign {campaignId} to user {recipientUserId} at {sendAt}.
        slots:
          campaignId: requestBody.campaignId
          recipientUserId: requestBody.recipientUserId
          sendAt: requestBody.sendAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webPush/target'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a web push via the simple endpoint
      effect: write
      questions:
      - Is there a plain /webPush/target call that sends a templated browser push by email?
      - How do I send a personalized web push with just an email and campaign?
      instructions:
      - text: Using /webPush/target, send campaign {campaignId} to {recipientEmail}.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
      - text: Send web push campaign {campaignId} to {recipientEmail} with data {dataFields} via the simple endpoint.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/iterable-web-push-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.