# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kit Custom Fields API
  version: 1.0.0
extends: openapi/convertkit-custom-fields-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v4/bulk/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many custom fields at once
      effect: write
      questions:
      - Can I create a batch of new custom fields in one request?
      - How do I get notified when a bulk custom field creation finishes?
      instructions:
      - text: 'Bulk create these custom fields: {custom_fields}.'
        slots:
          custom_fields: requestBody.custom_fields
      - text: Create the custom fields {custom_fields} in bulk and post the result to {callback_url}.
        slots:
          custom_fields: requestBody.custom_fields
          callback_url: requestBody.callback_url
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/bulk/custom_fields/subscribers'].post
  update:
    x-apievangelist-phrasing:
      intent: Set custom field values for many subscribers
      effect: write
      questions:
      - How do I update custom field values for thousands of subscribers at once?
      - Can I bulk-fill a field like last name across many subscribers asynchronously?
      instructions:
      - text: Bulk update subscriber custom field values {custom_field_values} and call {callback_url} when done.
        slots:
          custom_field_values: requestBody.custom_field_values
          callback_url: requestBody.callback_url
      - text: 'Apply these field values to many subscribers at once: {custom_field_values}, notifying {callback_url}.'
        slots:
          custom_field_values: requestBody.custom_field_values
          callback_url: requestBody.callback_url
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom fields
      effect: read
      questions:
      - What custom fields have I defined for collecting subscriber data?
      - Which field keys should I use when setting subscriber custom values?
      instructions:
      - text: List all custom fields on my account.
      - text: Show my custom fields, {per_page} per page.
        slots:
          per_page: query.per_page
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field
      effect: write
      questions:
      - How do I add a new custom field like Last Name to my subscriber records?
      - Does a custom field label need to be unique on my account?
      instructions:
      - text: Create a custom field labeled {label}.
        slots:
          label: requestBody.label
      - text: Add a new subscriber field called {label}.
        slots:
          label: requestBody.label
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/custom_fields/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a custom field's label
      effect: write
      questions:
      - Can I rename an existing custom field without losing subscriber data?
      - What happens to a field's key when I change its label?
      instructions:
      - text: Rename custom field {id} to {label}.
        slots:
          id: path.id
          label: requestBody.label
      - text: Change the label on existing custom field {id} to {label}.
        slots:
          id: path.id
          label: requestBody.label
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/custom_fields/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field and its data
      effect: destructive
      questions:
      - What happens to subscriber data when I delete a custom field?
      - How do I remove a custom field I no longer use?
      instructions:
      - text: Delete custom field {id}.
        slots:
          id: path.id
      - text: Remove custom field {id} and wipe its values from all subscribers.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'