# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform REST User Custom Fields API
  version: 1.0.0
extends: openapi/vendasta-user-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: 4
- target: $.paths['/users/{id}/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a user's custom fields
      effect: read
      questions:
      - Which HTTP verbs does the custom fields list nested under a user accept?
      - Is a user's embedded custom field collection reachable via a CORS preflight?
      instructions:
      - text: Preflight the custom fields nested under user {id}.
        slots:
          id: path.id
      - text: Report the verbs allowed on users/{id}/customFields.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userCustomFields/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's custom field values
      effect: read
      questions:
      - What partner-defined custom field values are stored on a user?
      - Can I read the extra attributes set up for users in Partner Center?
      instructions:
      - text: Get the custom fields for user {id}.
        slots:
          id: path.id
      - text: Show the custom attribute values recorded on user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userCustomFields/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's custom field values
      effect: write
      questions:
      - Can I change the value of a custom field on a user?
      - How would I set partner-defined attributes on a user record?
      instructions:
      - text: Update the custom fields of user {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Set user {id}'s custom attribute values to {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userCustomFields/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a user custom fields record
      effect: read
      questions:
      - What verbs does the standalone userCustomFields record permit cross-origin?
      - Can a browser patch a user custom field set after the preflight?
      instructions:
      - text: Run OPTIONS on userCustomFields record {id}.
        slots:
          id: path.id
      - text: List the methods user custom field set {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'