# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign eSignature REST Recipients API
  version: 1.0.0
extends: openapi/docusign-recipients-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['/accounts/{accountId}/envelopes/{envelopeId}/recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: List an envelope's recipients and their status
      effect: read
      questions:
      - Which people are on an envelope and what is each one's signing status?
      - Can I see delivery method and authentication details for an envelope's recipients?
      instructions:
      - text: List the recipients on envelope {envelopeId}.
        slots:
          envelopeId: path.envelopeId
      - text: Show envelope {envelopeId} recipients in account {accountId} with extended details.
        slots:
          envelopeId: path.envelopeId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}/recipients'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit recipients on an envelope
      effect: write
      questions:
      - Can I change a recipient's name, email or routing order on an envelope?
      - Can I resend an envelope after editing its recipients?
      instructions:
      - text: Change the signers on envelope {envelopeId} to {signers}.
        slots:
          envelopeId: path.envelopeId
          signers: requestBody.signers
      - text: Edit recipients on envelope {envelopeId} in account {accountId} and set resend to {resend_envelope}.
        slots:
          envelopeId: path.envelopeId
          accountId: path.accountId
          resend_envelope: query.resend_envelope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}/recipients'].post
  update:
    x-apievangelist-phrasing:
      intent: Add new recipients to an envelope
      effect: write
      questions:
      - Does adding a recipient to a sent envelope create a corrected version?
      - Can I add an in-person signer to a draft envelope?
      instructions:
      - text: Add signer {signers} to envelope {envelopeId}.
        slots:
          signers: requestBody.signers
          envelopeId: path.envelopeId
      - text: Add in-person signers {inPersonSigners} to envelope {envelopeId} in account {accountId}.
        slots:
          inPersonSigners: requestBody.inPersonSigners
          envelopeId: path.envelopeId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}/recipients'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete recipients from an envelope
      effect: destructive
      questions:
      - Can I take signers off a draft or sent envelope?
      - Which recipients can be deleted from an envelope?
      instructions:
      - text: Delete signers {signers} from envelope {envelopeId}.
        slots:
          signers: requestBody.signers
          envelopeId: path.envelopeId
      - text: Take the specified recipients off envelope {envelopeId} in account {accountId}.
        slots:
          envelopeId: path.envelopeId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'