Constant Contact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AppConnect V3 Email Scheduling API

7 actions 7 updates phrasing extends openapi/constant-contact-email-scheduling-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['/emails/activities/{campaign_activity_id}/schedules'].get
$.paths['/emails/activities/{campaign_activity_id}/schedules'].post
$.paths['/emails/activities/{campaign_activity_id}/schedules'].delete
$.paths['/emails/activities/{campaign_activity_id}/tests'].post
$.paths['/emails/activities/{campaign_activity_id}/previews'].get
$.paths['/emails/activities/{campaign_activity_id}/send_history'].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 Email Scheduling API
  version: 1.0.0
extends: openapi/constant-contact-email-scheduling-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['/emails/activities/{campaign_activity_id}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: Check when an email is scheduled to send
      effect: read
      questions:
      - When is my email scheduled to go out?
      - Is this email campaign activity actually scheduled?
      instructions:
      - text: Show the schedule for {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Check the send date of email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/activities/{campaign_activity_id}/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Send or schedule an email
      effect: write
      questions:
      - Can I send an email right now or schedule it for later?
      - What date format do I use to schedule an email campaign?
      instructions:
      - text: Schedule {campaign_activity_id} to send at {scheduled_date}.
        slots:
          campaign_activity_id: path.campaign_activity_id
          scheduled_date: requestBody.scheduled_date
      - text: Send email activity {campaign_activity_id} with scheduled date {scheduled_date}.
        slots:
          campaign_activity_id: path.campaign_activity_id
          scheduled_date: requestBody.scheduled_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/activities/{campaign_activity_id}/schedules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unschedule an email
      effect: destructive
      questions:
      - Can I stop a scheduled email from sending?
      - What status does an email go back to when I unschedule it?
      instructions:
      - text: Unschedule email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Cancel the scheduled send of {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/activities/{campaign_activity_id}/tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test email
      effect: write
      questions:
      - Can I send myself a test before the real send?
      - Is it possible to include a personal note in a test email?
      instructions:
      - text: Send a test of {campaign_activity_id} to {email_addresses}.
        slots:
          campaign_activity_id: path.campaign_activity_id
          email_addresses: requestBody.email_addresses
      - text: Test send {campaign_activity_id} to {email_addresses} with note {personal_message}.
        slots:
          campaign_activity_id: path.campaign_activity_id
          email_addresses: requestBody.email_addresses
          personal_message: requestBody.personal_message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/activities/{campaign_activity_id}/previews'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview an email's HTML
      effect: read
      questions:
      - What will my email look like before I send it?
      - Can I get the rendered HTML preview of an email activity?
      instructions:
      - text: Get the HTML preview of {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: Render a preview of email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/activities/{campaign_activity_id}/send_history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email's send history
      effect: read
      questions:
      - How many times has this email been sent, and to which lists?
      - Can I see past send dates and counts for an email activity?
      instructions:
      - text: Show the send history of {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      - text: List every past send of email activity {campaign_activity_id}.
        slots:
          campaign_activity_id: path.campaign_activity_id
      method: generated
      generated: '2026-10-01'