Constant Contact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AppConnect V3 Contacts Custom Fields API

6 actions 6 updates phrasing extends openapi/constant-contact-contacts-custom-fields-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 6

$.info

$.paths['/contact_custom_fields/{custom_field_id}'].get

$.paths['/contact_custom_fields/{custom_field_id}'].put

$.paths['/contact_custom_fields/{custom_field_id}'].delete

$.paths['/contact_custom_fields'].get

$.paths['/contact_custom_fields'].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 AppConnect V3 Contacts Custom Fields API
  version: 1.0.0
extends: openapi/constant-contact-contacts-custom-fields-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: 5
- target: $.paths['/contact_custom_fields/{custom_field_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field
      effect: read
      questions:
      - What type and label does a specific custom field have?
      - Can I look up a custom field by its ID?
      instructions:
      - text: Show custom field {custom_field_id}.
        slots:
          custom_field_id: path.custom_field_id
      - text: Get the details of custom field {custom_field_id}.
        slots:
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_custom_fields/{custom_field_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field
      effect: write
      questions:
      - Can I rename a custom field's label?
      - Is it possible to change the choices on a dropdown custom field?
      instructions:
      - text: Rename custom field {custom_field_id} to {label}.
        slots:
          custom_field_id: path.custom_field_id
          label: requestBody.label
      - text: Set the choices of custom field {custom_field_id} to {choices}.
        slots:
          custom_field_id: path.custom_field_id
          choices: requestBody.choices
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_custom_fields/{custom_field_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single custom field
      effect: destructive
      questions:
      - Can I remove one custom field I no longer use?
      - What happens when I delete a custom field from my account?
      instructions:
      - text: Delete custom field {custom_field_id}.
        slots:
          custom_field_id: path.custom_field_id
      - text: Remove custom field {custom_field_id} from my account.
        slots:
          custom_field_id: path.custom_field_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List all custom fields
      effect: read
      questions:
      - Which custom fields are defined in my account?
      - Can I page through my custom fields?
      instructions:
      - text: List all my custom fields.
      - text: List my custom fields, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact_custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field
      effect: write
      questions:
      - How do I add a custom field to store membership level?
      - What field types can a new custom field be?
      instructions:
      - text: Create a custom field labeled {label}.
        slots:
          label: requestBody.label
      - text: Create a {type} custom field called {label} with choices {choices}.
        slots:
          type: requestBody.type
          label: requestBody.label
          choices: requestBody.choices
      method: generated
      generated: '2026-10-01'