# 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 Document Fields API
  version: 1.0.0
extends: openapi/docusign-envelopedocumentfields-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}/documents/{documentId}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom fields on an envelope document
      effect: read
      questions:
      - What custom document fields are set on a document in a sent envelope?
      - Can I read the metadata fields attached to an envelope document?
      instructions:
      - text: Get the custom fields on document {document} of envelope {envelope} in account {account}.
        slots:
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Show document fields for envelope {envelope}, document {document}, account {account}.
        slots:
          envelope: path.envelopeId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Update custom fields on an envelope document
      effect: write
      questions:
      - How do I change the value of an existing custom field on an envelope document?
      - Can document field values be edited after the envelope is created?
      instructions:
      - text: Update fields {fields} on document {document} in envelope {envelope}, account {account}.
        slots:
          fields: requestBody.documentFields
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Change existing document field values on envelope {envelope} document {document} in account {account}.
        slots:
          envelope: path.envelopeId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add custom fields to an envelope document
      effect: write
      questions:
      - Can I attach new custom metadata fields to a document in an envelope?
      - How do I add document fields to an envelope that already exists?
      instructions:
      - text: Add fields {fields} to document {document} in envelope {envelope}, account {account}.
        slots:
          fields: requestBody.documentFields
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Create new custom fields on envelope {envelope} document {document} for account {account}.
        slots:
          envelope: path.envelopeId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove custom fields from an envelope document
      effect: destructive
      questions:
      - Can I delete custom fields from a document in an envelope?
      - How do I clear metadata fields off an envelope document?
      instructions:
      - text: Delete fields {fields} from document {document} in envelope {envelope}, account {account}.
        slots:
          fields: requestBody.documentFields
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Remove custom document fields from envelope {envelope} document {document} on account {account}.
        slots:
          envelope: path.envelopeId
          document: path.documentId
          account: path.accountId
      method: generated
      generated: '2026-10-01'