Attentive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attentive Offers API

2 actions 2 updates phrasing extends openapi/attentive-offers-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Attentive's API. It is a proposal applied on top of the contract, not a document Attentive publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/coupons/coupon-pool/{coupon-pool-id}/create'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Attentive Offers API
  version: 1.0.0
extends: openapi/attentive-offers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/coupons/coupon-pool/{coupon-pool-id}/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add discount codes to an offer
      effect: write
      questions:
      - How do I upload my own discount codes into an Attentive offer?
      - How many discount codes can I add in a single request?
      - Can I set a window when uploaded coupon codes become valid for messages?
      instructions:
      - text: Add discount codes {codes} to coupon pool {coupon-pool-id}.
        slots:
          codes: requestBody.codes
          coupon-pool-id: path.coupon-pool-id
      - text: Load codes {codes} into offer {coupon-pool-id}, valid from {distributionStart} to {distributionStop}.
        slots:
          codes: requestBody.codes
          coupon-pool-id: path.coupon-pool-id
          distributionStart: requestBody.distributionStart
          distributionStop: requestBody.distributionStop
      method: generated
      generated: '2026-09-26'