Iterable

Iterable Whats App API

The Whats App API from Iterable — 2 operation(s) for whats app.

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/whatsApp/cancel Cancel a scheduled WhatsApp message · Cancel a scheduled WhatsApp message #
Ask an LLM
“Can I cancel a WhatsApp message scheduled for one user?”
“What identifies the WhatsApp send I want to cancel?”
Tell an agent destructive · confirm first
Cancel the WhatsApp message from campaign {campaignId} to {email}.
Cancel scheduled WhatsApp message {scheduledMessageId}.
POST /api/whatsApp/target Send a WhatsApp message to a user · Send a WhatsApp message to a user #
Ask an LLM
“How do I send a WhatsApp message to one user from a campaign?”
“Can I schedule a WhatsApp send for later?”
Tell an agent
Send WhatsApp campaign {campaignId} to {recipientEmail}.
Send WhatsApp campaign {campaignId} to user {recipientUserId} at {sendAt}.

Documentation

📖
Documentation
https://api.iterable.com/api/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/iterable/refs/heads/main/openapi/iterable-whats-app-api-openapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/iterable:iterable-whats-app-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

iterable-whats-app-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  termsOfService: https://iterable.com/terms/
  title: Iterable WhatsApp API
  version: '1.8'
servers:
- url: https://api.iterable.com/
security:
- api_key: []
tags:
- name: Whats App
paths:
  /api/whatsApp/cancel:
    post:
      description: 'Cancels the sending of a scheduled WhatsApp message to a specific user.


        Learn about identifying users by userId and email.'
      operationId: cancel
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IterableApiResponse'
        '400':
          description: Invalid parameters
        '401':
          description: Invalid API key
      summary: Cancel a scheduled WhatsApp message
      tags:
      - Whats App
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelScheduledMessageRequest_-_campaignId_OR_scheduledMessageId_are_required'
        description: Email and Campaign ID
        required: true
  /api/whatsApp/target:
    post:
      description: 'Send a WhatsApp message to a user. Request data fields will override user profile data fields.


        Learn about identifying users by userId and email.'
      operationId: target
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IterableApiResponse'
        '400':
          description: Invalid parameters
        '401':
          description: Invalid API key
      summary: Send a WhatsApp message to a user
      tags:
      - Whats App
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TargetWhatsAppRequest'
        description: Recipient and email id
        required: true
components:
  schemas:
    TargetWhatsAppRequest:
      properties:
        allowRepeatMarketingSends:
          description: Allow repeat marketing sends? Defaults to true.
          type: boolean
        campaignId:
          description: Campaign ID
          format: int64
          type: integer
        dataFields:
          description: Data fields that can be referenced in the template or campaign content
          type: object
        recipientEmail:
          description: An email address that identifies a user profile in Iterable. Provide a <code>recipientEmail</code> or a <code>recipientUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.
          type: string
        recipientUserId:
          description: A user ID that identifies a user profile in Iterable. Provide a <code>recipientEmail</code> or a <code>recipientUserId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.
          type: string
        sendAt:
          description: Schedule the message for up to 365 days in the future. If set in the past, message is sent immediately. Format is <code>YYYY-MM-DD HH:MM:SS</code> (UTC).
          type: string
      required:
      - campaignId
      type: object
    CancelScheduledMessageRequest_-_campaignId_OR_scheduledMessageId_are_required:
      properties:
        campaignId:
          description: The ID of the campaign associated with the scheduled message you'd like to cancel. If you provide a <code>campaignId</code>, you must also provide an <code>email</code> or <code>userId</code>, depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.
          type: number
        email:
          description: An email address that identifies a user profile in Iterable. If you provide a <code>campaignId</code>, you must also provide an <code>email</code> or a <code>userId</code>, depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.
          type: string
        scheduledMessageId:
          type: number
        userId:
          description: A user ID that identifies a user profile in Iterable. If you provide a <code>campaignId</code>, you must also provide an <code>email</code> or a <code>userId</code>, depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.
          type: string
      type: object
    IterableApiResponse:
      properties:
        code:
          enum:
          - Success
          - BadApiKey
          - BadAuthorizationHeader
          - BadJsonBody
          - BadParams
          - BatchTooLarge
          - DatabaseError
          - EmailAlreadyExists
          - ExternalKeyConflict
          - Forbidden
          - ForbiddenParamsError
          - ForgottenUserError
          - GenericError
          - InvalidEmailAddressError
          - InvalidJwtPayload
          - InvalidUserIdError
          - JwtUserIdentifiersMismatched
          - NotFound
          - QueueEmailError
          - RateLimitExceeded
          - RequestFieldsTypesMismatched
          - Unauthorized
          - UniqueFieldsLimitExceeded
          - UnknownEmailError
          - UnknownUserIdError
          - UserIdAlreadyExists
          type: string
        msg:
          description: Response description
          type: string
        params:
          description: Additional info
          type: object
      required:
      - code
      - msg
      type: object
  securitySchemes:
    api_key:
      in: header
      name: Api-Key
      type: apiKey