# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Website Promotions API
  version: 1.0.0
extends: openapi/optimizely-website-promotions-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: 9
- target: $.paths['/api/v1/admin/WebsitePromotions'].get
  update:
    x-apievangelist-phrasing:
      intent: List website-promotion assignments
      effect: read
      questions:
      - Which promotions are running on which websites?
      - Can I filter website promotions to one site?
      instructions:
      - text: List all website-promotion assignments.
      - text: Find website promotions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsitePromotions'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a promotion on a website
      effect: write
      questions:
      - How do I make a promotion available on a specific website?
      - Can I assign a promotion to a storefront site?
      instructions:
      - text: Assign promotion {promotionId} to website {websiteId}.
        slots:
          promotionId: requestBody.promotionId
          websiteId: requestBody.websiteId
      - text: Enable promotion {promotionId} on site {websiteId}.
        slots:
          promotionId: requestBody.promotionId
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsitePromotions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website-promotion assignment
      effect: read
      questions:
      - Can I look up one website-promotion link by ID?
      - Which website and promotion does an assignment connect?
      instructions:
      - text: Show website-promotion assignment {id}.
        slots:
          id: path.id
      - text: Get the site and promotion for link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsitePromotions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website-promotion assignment
      effect: write
      questions:
      - How do I overwrite a website-promotion link entirely?
      - Can I replace an assignment with a different site and promotion?
      instructions:
      - text: Replace assignment {id} with website {websiteId} and promotion {promotionId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
          promotionId: requestBody.promotionId
      - text: Overwrite website-promotion link {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsitePromotions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a promotion from a website
      effect: destructive
      questions:
      - How do I stop a promotion running on a website?
      - Can I delete a website-promotion link with an ETag check?
      instructions:
      - text: Delete website-promotion assignment {id}.
        slots:
          id: path.id
      - text: Remove link {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsitePromotions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a website-promotion assignment
      effect: write
      questions:
      - Can I move a promotion assignment to a different website?
      - How do I swap the promotion on an existing website link?
      instructions:
      - text: Move assignment {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      - text: Change the promotion on link {id} to {promotionId}.
        slots:
          id: path.id
          promotionId: requestBody.promotionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsitePromotions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new website promotion
      effect: read
      questions:
      - What defaults does a new website-promotion assignment start with?
      - Is there an empty template for a website-promotion link?
      instructions:
      - text: Get the default website-promotion template.
      - text: Show prefilled defaults for a new website-promotion link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitepromotions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove website-promotion assignments
      effect: destructive
      questions:
      - Can I delete many website-promotion links in one call?
      - How do I bulk pull promotions off websites by ID?
      instructions:
      - text: Bulk delete website-promotion assignments {ids}.
        slots:
          ids: query.ids
      - text: Remove the website-promotion links with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitepromotions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a website promotion
      effect: read
      questions:
      - Can I read a custom property on a website-promotion assignment?
      - Where do extra fields for a website-promotion link live?
      instructions:
      - text: Show custom property {property} on website-promotion link {key}.
        slots:
          property: path.custompropertyKey
          key: path.key
      - text: Get assignment {key}'s custom field {property}.
        slots:
          property: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'