Constant Contact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AppConnect V3 Contact Lists API

7 actions 7 updates phrasing extends openapi/constant-contact-contact-lists-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Constant Contact's API. It is a proposal applied on top of the contract, not a document Constant Contact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/contact_lists/{list_id}'].get
$.paths['/contact_lists/{list_id}'].put
$.paths['/contact_lists/{list_id}'].delete
$.paths['/contact_lists'].get
$.paths['/contact_lists'].post
$.paths['/contact_lists/list_id_xrefs'].get

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 AppConnect V3 Contact Lists API
  version: 1.0.0
extends: openapi/constant-contact-contact-lists-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: 6
- target: $.paths['/contact_lists/{list_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one contact list
      effect: read
      questions:
      - What are the details of a specific contact list?
      - Can I see how many members a single list has?
      instructions:
      - text: Show contact list {list_id}.
        slots:
          list_id: path.list_id
      - text: Get list {list_id} with its membership count.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_lists/{list_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit a contact list
      effect: write
      questions:
      - Can I rename a contact list or change its description?
      - Is it possible to mark an existing list as a favorite?
      instructions:
      - text: Rename list {list_id} to {name}.
        slots:
          list_id: path.list_id
          name: requestBody.name
      - text: Update list {list_id} name to {name} with description {description}.
        slots:
          list_id: path.list_id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_lists/{list_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single contact list
      effect: destructive
      questions:
      - What happens to members when I delete one list?
      - Can I track whether a list deletion has finished?
      instructions:
      - text: Delete contact list {list_id}.
        slots:
          list_id: path.list_id
      - text: Remove list {list_id} and its memberships.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List all contact lists
      effect: read
      questions:
      - Which contact lists do I have in my account?
      - Can I search my lists by name or include member counts?
      instructions:
      - text: List all my contact lists.
      - text: Find contact lists named {name}.
        slots:
          name: query.name
      - text: List contact lists with status {status} and their membership counts.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact list
      effect: write
      questions:
      - How do I make a new contact list?
      - Can I add a description when creating a list?
      instructions:
      - text: Create a contact list called {name}.
        slots:
          name: requestBody.name
      - text: Create a new list {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_lists/list_id_xrefs'].get
  update:
    x-apievangelist-phrasing:
      intent: Map old V2 list IDs to V3 list IDs
      effect: read
      questions:
      - I have list IDs stored from the V2 API — what are their V3 equivalents?
      - Can I migrate legacy list identifiers to the new format?
      instructions:
      - text: Translate V2 list IDs {sequence_ids} to V3 list IDs.
        slots:
          sequence_ids: query.sequence_ids
      - text: Get the V3 list IDs for legacy lists {sequence_ids}.
        slots:
          sequence_ids: query.sequence_ids
      method: generated
      generated: '2026-10-01'