Constant Contact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AppConnect V3 Bulk Activities API

15 actions 15 updates phrasing extends openapi/constant-contact-bulk-activities-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 15

$.info
$.paths['/activities'].get
$.paths['/activities/{activity_id}'].get
$.paths['/activities/contact_exports'].post
$.paths['/contact_exports/{file_export_id}'].get
$.paths['/activities/contact_delete'].post
$.paths['/activities/contacts_file_import'].post
$.paths['/activities/contacts_json_import'].post
$.paths['/activities/remove_list_memberships'].post
$.paths['/activities/add_list_memberships'].post
$.paths['/activities/list_delete'].post
$.paths['/activities/contacts_taggings_remove'].post
$.paths['/activities/contacts_taggings_add'].post
$.paths['/activities/contacts_tags_delete'].post
$.paths['/activities/custom_fields_delete'].post

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 Bulk Activities API
  version: 1.0.0
extends: openapi/constant-contact-bulk-activities-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: 14
- target: $.paths['/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk activities and their status
      effect: read
      questions:
      - Which of my bulk jobs failed or timed out?
      - Can I see all background activities that are still processing?
      instructions:
      - text: List my recent bulk activities.
      - text: Show bulk activities in state {state}.
        slots:
          state: query.state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/{activity_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one bulk activity
      effect: read
      questions:
      - Has my contact import finished yet?
      - Where can I see the progress and errors for a specific bulk job?
      instructions:
      - text: Check the status of activity {activity_id}.
        slots:
          activity_id: path.activity_id
      - text: Get the status report for bulk job {activity_id}.
        slots:
          activity_id: path.activity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/contact_exports'].post
  update:
    x-apievangelist-phrasing:
      intent: Export contacts to a CSV file
      effect: write
      questions:
      - Can I export all my contacts to a CSV?
      - Is it possible to export only the contacts in certain lists or a segment?
      instructions:
      - text: Export all my contacts to CSV.
      - text: Export the contacts in lists {list_ids} to a CSV file.
        slots:
          list_ids: requestBody.list_ids
      - text: Start a CSV export of segment {segment_id} with fields {fields}.
        slots:
          segment_id: requestBody.segment_id
          fields: requestBody.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_exports/{file_export_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a finished contacts export file
      effect: read
      questions:
      - Where do I download the CSV once my contact export is done?
      - Can I retrieve the exported contacts file by its activity ID?
      instructions:
      - text: Download the exported contacts file {file_export_id}.
        slots:
          file_export_id: path.file_export_id
      - text: Get the CSV from completed export {file_export_id}.
        slots:
          file_export_id: path.file_export_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/contact_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete contacts
      effect: destructive
      questions:
      - Can I delete hundreds of contacts at once?
      - Is there a way to delete every contact that belongs to certain lists?
      instructions:
      - text: Bulk delete contacts {contact_ids}.
        slots:
          contact_ids: requestBody.contact_ids
      - text: Delete every contact who is a member of lists {list_ids}.
        slots:
          list_ids: requestBody.list_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/contacts_file_import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import contacts from a CSV file
      effect: write
      questions:
      - Can I upload a CSV of contacts and add them to a list?
      - What happens to existing contacts when I import a CSV file?
      instructions:
      - text: Import contacts from {file} into lists {list_ids}.
        slots:
          file: requestBody.file
          list_ids: requestBody.list_ids
      - text: Upload CSV {file} to lists {list_ids} with SMS permission {sms_permission_to_send}.
        slots:
          file: requestBody.file
          list_ids: requestBody.list_ids
          sms_permission_to_send: requestBody.sms_permission_to_send
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/contacts_json_import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import contacts from a JSON payload
      effect: write
      questions:
      - Can I bulk add or update contacts by sending JSON instead of a file?
      - Which lists do imported JSON contacts get added to?
      instructions:
      - text: Import contacts {import_data} as JSON into lists {list_ids}.
        slots:
          import_data: requestBody.import_data
          list_ids: requestBody.list_ids
      - text: Run a JSON contact import of {import_data} to lists {list_ids}.
        slots:
          import_data: requestBody.import_data
          list_ids: requestBody.list_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/remove_list_memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove contacts from lists in bulk
      effect: write
      questions:
      - Can I take a group of contacts off several lists without deleting them?
      - Is it possible to clear list memberships for contacts in bulk?
      instructions:
      - text: Remove contacts {source} from lists {list_ids}.
        slots:
          source: requestBody.source
          list_ids: requestBody.list_ids
      - text: Take contacts matching {source} off lists {list_ids}, except {exclude}.
        slots:
          source: requestBody.source
          list_ids: requestBody.list_ids
          exclude: requestBody.exclude
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/add_list_memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Add contacts to lists in bulk
      effect: write
      questions:
      - Can I copy every contact from one list into another list?
      - How many lists can a single contact belong to?
      instructions:
      - text: Add contacts {source} to lists {list_ids}.
        slots:
          source: requestBody.source
          list_ids: requestBody.list_ids
      - text: Bulk add contacts from {source} into lists {list_ids}, skipping {exclude}.
        slots:
          source: requestBody.source
          list_ids: requestBody.list_ids
          exclude: requestBody.exclude
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/list_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many contact lists at once
      effect: destructive
      questions:
      - Can I delete up to 100 contact lists in one go?
      - Is there a bulk way to clean out old contact lists?
      instructions:
      - text: Delete contact lists {list_ids} in bulk.
        slots:
          list_ids: requestBody.list_ids
      - text: 'Remove these lists from my account all at once: {list_ids}.'
        slots:
          list_ids: requestBody.list_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/contacts_taggings_remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from contacts in bulk
      effect: write
      questions:
      - Can I untag a whole group of contacts without deleting the tag?
      - Is there a bulk way to strip certain tags off contacts in a list?
      instructions:
      - text: Remove tags {tag_ids} from contacts {source}.
        slots:
          tag_ids: requestBody.tag_ids
          source: requestBody.source
      - text: Untag contacts matching {source} from {tag_ids}.
        slots:
          source: requestBody.source
          tag_ids: requestBody.tag_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/contacts_taggings_add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tags to contacts in bulk
      effect: write
      questions:
      - Can I tag every contact on a list at once?
      - What ways can I choose which contacts get a tag in bulk?
      instructions:
      - text: Add tags {tag_ids} to contacts {source}.
        slots:
          tag_ids: requestBody.tag_ids
          source: requestBody.source
      - text: Bulk tag contacts matching {source} with {tag_ids}, excluding {exclude}.
        slots:
          source: requestBody.source
          tag_ids: requestBody.tag_ids
          exclude: requestBody.exclude
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/contacts_tags_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many tags at once
      effect: destructive
      questions:
      - Can I delete up to 500 tags in a single request?
      - When I bulk delete tags, are they also removed from tagged contacts?
      instructions:
      - text: Delete tags {tag_ids} in bulk.
        slots:
          tag_ids: requestBody.tag_ids
      - text: 'Bulk remove these tags from my account entirely: {tag_ids}.'
        slots:
          tag_ids: requestBody.tag_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activities/custom_fields_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many custom fields at once
      effect: destructive
      questions:
      - Can I delete up to 100 custom fields in one request?
      - Is there a bulk way to remove unused custom fields?
      instructions:
      - text: Bulk delete custom fields {custom_field_ids}.
        slots:
          custom_field_ids: requestBody.custom_field_ids
      - text: 'Remove these custom fields all at once: {custom_field_ids}.'
        slots:
          custom_field_ids: requestBody.custom_field_ids
      method: generated
      generated: '2026-10-01'