# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ActiveCampaign API v3 Fields API
  version: 1.0.0
extends: openapi/activecampaign-fields-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: 13
- target: $.paths['/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact custom fields
      effect: read
      questions:
      - What custom contact fields exist in my ActiveCampaign account?
      - Can I find a custom field by its personalization tag?
      instructions:
      - text: List all contact custom fields.
      - text: Find the custom field with personalization tag {perstag}.
        slots:
          perstag: query.filters[perstag]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact custom field
      effect: write
      questions:
      - How do I add a custom field like Company Size to contacts?
      - Can I create a dropdown or date custom field for contacts?
      instructions:
      - text: Create a contact custom field with {field}.
        slots:
          field: requestBody.field
      - text: Add a Birthday date field to contacts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact custom field
      effect: read
      questions:
      - Where do I see the definition of one contact custom field?
      - What type and tag does contact field 9 have?
      instructions:
      - text: Show contact custom field {id}.
        slots:
          id: path.id
      - text: Get the settings of custom field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact custom field
      effect: write
      questions:
      - Can I rename a contact custom field or change its type?
      - Is it possible to edit a custom field's default value?
      instructions:
      - text: Update custom field {id} with {field}.
        slots:
          id: path.id
          field: requestBody.field
      - text: Rename contact custom field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fields/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact custom field
      effect: destructive
      questions:
      - How do I delete a contact custom field I don't need?
      - Does removing a custom field erase it from every contact?
      instructions:
      - text: Delete contact custom field {id}.
        slots:
          id: path.id
      - text: Remove the unused contact field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldRels'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a custom field to lists
      effect: write
      questions:
      - Can I make a custom field available only on certain lists?
      - How do I link a contact field to a list?
      instructions:
      - text: Relate a custom field to lists using {fieldRel}.
        slots:
          fieldRel: requestBody.fieldRel
      - text: Make the Company Size field available on my Newsletter list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldOption/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Add options to a dropdown custom field
      effect: write
      questions:
      - How do I add choices to a dropdown or checkbox custom field?
      - Can I set one of the field options as the default?
      instructions:
      - text: Add option {value} labeled {label} to field {field}.
        slots:
          value: requestBody.value
          label: requestBody.label
          field: requestBody.field
      - text: Add option {value} to custom field {field} and make it the default ({isdefault}).
        slots:
          value: requestBody.value
          field: requestBody.field
          isdefault: requestBody.isdefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldRels/{fieldRelId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a custom field from a list
      effect: destructive
      questions:
      - Can I stop a custom field from showing on a particular list?
      - How do I remove a field-to-list relationship?
      instructions:
      - text: Delete field relationship {fieldRelId}.
        slots:
          fieldRelId: path.fieldRelId
      - text: Unlink the custom field from its list via relationship {fieldRelId}.
        slots:
          fieldRelId: path.fieldRelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldValues'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact custom field values
      effect: read
      questions:
      - Which contacts have a particular value in a custom field?
      - Can I list all values stored for one contact field?
      instructions:
      - text: List values stored for custom field {fieldid}.
        slots:
          fieldid: query.filters[fieldid]
      - text: Find contact field values equal to {val}.
        slots:
          val: query.filters[val]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a custom field value on a contact
      effect: write
      questions:
      - How do I fill in a custom field for one contact?
      - Can I save a custom field value and fall back to the field's defaults?
      instructions:
      - text: Set a contact custom field value with {fieldValue}.
        slots:
          fieldValue: requestBody.fieldValue
      - text: Store a contact's Company Size value, using defaults where blank ({useDefaults}).
        slots:
          useDefaults: requestBody.useDefaults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldValues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact custom field value
      effect: read
      questions:
      - Where do I look up one stored contact field value by ID?
      - What value is saved in contact field value record 55?
      instructions:
      - text: Show contact field value {id}.
        slots:
          id: path.id
      - text: Get stored custom field value {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldValues/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a contact custom field value
      effect: write
      questions:
      - Can I change a custom field value already set on a contact?
      - How do I correct a contact's saved field value?
      instructions:
      - text: Update contact field value {id} with {fieldValue}.
        slots:
          id: path.id
          fieldValue: requestBody.fieldValue
      - text: Correct the saved contact field value {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fieldValues/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a contact custom field value
      effect: destructive
      questions:
      - Is it possible to erase a custom field value from a contact?
      - What removes one stored contact field value?
      instructions:
      - text: Delete contact field value {id}.
        slots:
          id: path.id
      - text: Clear the contact's custom field entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'