Iterable REST API — Campaigns

naftiko: 1.0.0-alpha2
info:
  label: Iterable REST API — Campaigns
  description: 'Iterable REST API — Campaigns. 3 operations. Lead operation: List campaigns. Self-contained Naftiko capability
    covering one Iterable business surface.'
  tags:
  - Iterable
  - Campaigns
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ITERABLE_API_KEY: ITERABLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-campaigns
    baseUri: https://api.iterable.com/api
    description: Iterable REST API — Campaigns business capability. Self-contained, no shared references.
    resources:
    - name: campaigns
      path: /campaigns
      operations:
      - name: listcampaigns
        method: GET
        description: List campaigns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: campaigns-create
      path: /campaigns/create
      operations:
      - name: createcampaign
        method: POST
        description: Create a campaign
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: campaigns-metrics
      path: /campaigns/metrics
      operations:
      - name: getcampaignmetrics
        method: GET
        description: Get campaign metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: campaignId
          in: query
          type: array
          description: One or more campaign IDs to retrieve metrics for
          required: true
        - name: startDateTime
          in: query
          type: string
          description: Start date for the metrics period in ISO 8601 format
        - name: endDateTime
          in: query
          type: string
          description: End date for the metrics period in ISO 8601 format
    authentication:
      type: apikey
      key: Api-Key
      value: '{{env.ITERABLE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-campaigns-rest
    port: 8080
    description: REST adapter for Iterable REST API — Campaigns. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/campaigns
      name: campaigns
      description: REST surface for campaigns.
      operations:
      - method: GET
        name: listcampaigns
        description: List campaigns
        call: rest-campaigns.listcampaigns
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/create
      name: campaigns-create
      description: REST surface for campaigns-create.
      operations:
      - method: POST
        name: createcampaign
        description: Create a campaign
        call: rest-campaigns.createcampaign
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/metrics
      name: campaigns-metrics
      description: REST surface for campaigns-metrics.
      operations:
      - method: GET
        name: getcampaignmetrics
        description: Get campaign metrics
        call: rest-campaigns.getcampaignmetrics
        with:
          campaignId: rest.campaignId
          startDateTime: rest.startDateTime
          endDateTime: rest.endDateTime
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-campaigns-mcp
    port: 9090
    transport: http
    description: MCP adapter for Iterable REST API — Campaigns. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-campaigns
      description: List campaigns
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-campaigns.listcampaigns
      outputParameters:
      - type: object
        mapping: $.
    - name: create-campaign
      description: Create a campaign
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-campaigns.createcampaign
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-campaign-metrics
      description: Get campaign metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-campaigns.getcampaignmetrics
      with:
        campaignId: tools.campaignId
        startDateTime: tools.startDateTime
        endDateTime: tools.endDateTime
      outputParameters:
      - type: object
        mapping: $.