# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Envelope Custom Fields API
  version: 1.0.0
extends: openapi/docusign-envelopecustomfields-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['/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom fields on an envelope
      effect: read
      questions:
      - What custom field values were recorded on an envelope?
      - Can I read the text and list custom fields of a specific envelope?
      instructions:
      - text: Get the custom fields on envelope {envelope} in account {account}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Show custom field values for envelope {envelope}.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Update existing envelope custom fields
      effect: write
      questions:
      - How do I change a custom field value on an in-process envelope?
      - Can I edit the custom fields on a draft envelope?
      instructions:
      - text: Update the text custom fields on envelope {envelope} in account {account} to {textCustomFields}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          textCustomFields: requestBody.textCustomFields
      - text: Change list custom field values on envelope {envelope} to {listCustomFields}.
        slots:
          envelope: path.envelopeId
          listCustomFields: requestBody.listCustomFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add custom fields to an envelope
      effect: write
      questions:
      - How do I add a new custom field to an envelope that's already out?
      - Do custom fields I add to an envelope need unique names?
      instructions:
      - text: Add text custom fields {textCustomFields} to envelope {envelope} in account {account}.
        slots:
          textCustomFields: requestBody.textCustomFields
          envelope: path.envelopeId
          account: path.accountId
      - text: Add new list custom fields {listCustomFields} to envelope {envelope}.
        slots:
          listCustomFields: requestBody.listCustomFields
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete custom fields from an envelope
      effect: destructive
      questions:
      - How do I remove custom fields from a draft envelope?
      - Can I delete a single custom field from an in-process envelope?
      instructions:
      - text: Delete text custom fields {textCustomFields} from envelope {envelope} in account {account}.
        slots:
          textCustomFields: requestBody.textCustomFields
          envelope: path.envelopeId
          account: path.accountId
      - text: Remove list custom fields {listCustomFields} from envelope {envelope}.
        slots:
          listCustomFields: requestBody.listCustomFields
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'