# 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 Recipient Tabs API
  version: 1.0.0
extends: openapi/docusign-enveloperecipienttabs-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}/recipients/{recipientId}/tabs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recipient's tabs and values
      effect: read
      questions:
      - How do I read the values a signer typed into fields on a completed envelope?
      - Can I get the anchor locations of a recipient's tabs?
      instructions:
      - text: Get the tabs for recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Show recipient {recipient}'s field values on envelope {envelope} with metadata {include_metadata}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          include_metadata: query.include_metadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a recipient's existing tabs
      effect: write
      questions:
      - How do I change the value of a text field already assigned to a recipient?
      - Can I prefill a recipient's text tabs before the envelope is complete?
      instructions:
      - text: Update text tabs {textTabs} for recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          textTabs: requestBody.textTabs
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Change the checkbox tabs of recipient {recipient} on envelope {envelope} to {checkboxTabs}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          checkboxTabs: requestBody.checkboxTabs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tabs for a recipient
      effect: write
      questions:
      - How do I add a new sign-here field for a recipient?
      - Can I add date or initial fields to a signer after creating the envelope?
      instructions:
      - text: Add sign here tabs {signHereTabs} for recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          signHereTabs: requestBody.signHereTabs
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Add initial here tabs {initialHereTabs} for signer {recipient} on envelope {envelope}.
        slots:
          initialHereTabs: requestBody.initialHereTabs
          recipient: path.recipientId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a recipient's tabs
      effect: destructive
      questions:
      - How do I remove fields from a recipient on a draft envelope?
      - Can I delete just one sign-here tab from a signer?
      instructions:
      - text: Delete sign here tabs {signHereTabs} from recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          signHereTabs: requestBody.signHereTabs
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Remove text tabs {textTabs} from recipient {recipient} on draft envelope {envelope}.
        slots:
          textTabs: requestBody.textTabs
          recipient: path.recipientId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'