API Evangelist conversational phrasing for Docusign Envelopes API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Docusign Envelopes API
  version: 1.0.0
extends: openapi/docusign-envelopes-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: 21
- target: $.paths['/accounts/{accountId}/envelopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Search envelopes by date, status or text
      effect: read
      questions:
      - How do I find envelopes sent in a date range using the newer envelopes endpoint?
      - Can I search my envelopes by free text and sort the results?
      - Which envelopes in a given folder are still waiting for signatures?
      instructions:
      - text: List envelopes in account {account} with status {status} created since {from_date}.
        slots:
          account: path.accountId
          status: query.status
          from_date: query.from_date
      - text: Search envelopes in account {account} for the text {search_text}.
        slots:
          account: path.accountId
          search_text: query.search_text
      - text: Show envelopes in folder {folder_ids} for account {account}, ordered by {order_by}.
        slots:
          folder_ids: query.folder_ids
          account: path.accountId
          order_by: query.order_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an envelope from a template or documents
      effect: write
      questions:
      - How do I create an envelope from a template and fill in the template roles?
      - Can I save an envelope as a draft with the newer create endpoint instead of sending it right away?
      instructions:
      - text: Create an envelope in account {account} from template {templateId} with subject {emailSubject}.
        slots:
          account: path.accountId
          templateId: requestBody.templateId
          emailSubject: requestBody.emailSubject
      - text: Create a draft envelope in account {account} using brand {brandId}.
        slots:
          account: path.accountId
          brandId: requestBody.brandId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an envelope's details (unversioned path)
      effect: read
      questions:
      - Where can I see an envelope's sender, recipients and documents on the unversioned envelope endpoint?
      - Does the unversioned get-envelope call return the documents list along with the status?
      instructions:
      - text: Get envelope {envelope} in account {account} from the unversioned envelopes endpoint.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Fetch envelope {envelope} details including {include} via the unversioned path for account {account}.
        slots:
          envelope: path.envelopeId
          include: query.include
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{accountId}/envelopes/{envelopeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an envelope's subject or message
      effect: write
      questions:
      - How do I change the email subject on an envelope through the unversioned update endpoint?
      - Can I turn on expiration for an envelope after I've created it?
      instructions:
      - text: Change the email subject of envelope {envelope} in account {account} to {emailSubject}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          emailSubject: requestBody.emailSubject
      - text: Set envelope {envelope} in account {account} to expire after {expireAfter} days using the unversioned path.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          expireAfter: requestBody.expireAfter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get envelope status changes
      effect: read
      questions:
      - What envelopes changed status since a given date on the v2 API?
      - Can I check the status of several envelopes at once by passing their IDs in the query?
      - Which of my envelopes were sent to a particular recipient email?
      instructions:
      - text: List v2 envelope status changes in account {account} since {from_date}.
        slots:
          account: path.accountId
          from_date: query.from_date
      - text: Get status changes for envelopes {envelope_ids} in account {account}.
        slots:
          envelope_ids: query.envelope_ids
          account: path.accountId
      - text: Find envelopes in account {account} sent to {email} with status {status}.
        slots:
          account: path.accountId
          email: query.email
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and send an envelope (v2)
      effect: write
      questions:
      - How do I send documents for signature with the v2 envelopes API?
      - Can I require 21 CFR Part 11 compliance or a password when creating a v2 envelope?
      instructions:
      - text: Create and send a v2 envelope in account {account} with subject {emailSubject} and status {status}.
        slots:
          account: path.accountId
          emailSubject: requestBody.emailSubject
          status: requestBody.status
      - text: Create a v2 draft envelope in account {account} from template {templateId}.
        slots:
          account: path.accountId
          templateId: requestBody.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of one envelope (v2)
      effect: read
      questions:
      - What is the current status of a single envelope on the v2 API?
      - Has my envelope been completed or is it still out for signature?
      instructions:
      - text: Get the v2 status of envelope {envelope} in account {account}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Check whether envelope {envelope} in account {account} is completed.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send, void or purge an envelope
      effect: destructive
      questions:
      - How do I void an envelope that's still in process and give a reason?
      - Can I send a draft envelope I created earlier?
      - Is there a way to purge documents from a completed envelope?
      instructions:
      - text: Void envelope {envelope} in account {account} with reason {voidedReason}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          voidedReason: requestBody.voidedReason
      - text: Send draft envelope {envelope} in account {account} by setting its status to {status}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          status: requestBody.status
      - text: Purge documents from completed envelope {envelope} in account {account} with purge state {purgeState}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
          purgeState: requestBody.purgeState
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/audit_events'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an envelope's audit trail
      effect: read
      questions:
      - Where can I see the audit history of who opened and signed an envelope?
      - Does the API expose the audit events log for an envelope?
      instructions:
      - text: Get the audit events for envelope {envelope} in account {account}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Show me the audit trail of envelope {envelope}.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get page images for an envelope document
      effect: read
      questions:
      - Can I render all the pages of a document in an envelope as images?
      - How do I get page thumbnails at a lower DPI for an envelope document?
      instructions:
      - text: Get page images of document {document} in envelope {envelope} for account {account}.
        slots:
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Get {count} page images at {dpi} DPI from document {document} in envelope {envelope}.
        slots:
          count: query.count
          dpi: query.dpi
          document: path.documentId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a page from an envelope document
      effect: destructive
      questions:
      - Can I remove a single page from a document already in an envelope?
      - How do I drop page 3 from a document in my envelope?
      instructions:
      - text: Delete page {page} of document {document} in envelope {envelope} for account {account}.
        slots:
          page: path.pageNumber
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Remove page {page} from document {document} of envelope {envelope}.
        slots:
          page: path.pageNumber
          document: path.documentId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one page image from an envelope
      effect: read
      questions:
      - How do I display a single page of an envelope document as an image?
      - Can I limit the width and height of a page image I fetch?
      instructions:
      - text: Get the image for page {page} of document {document} in envelope {envelope}, account {account}.
        slots:
          page: path.pageNumber
          document: path.documentId
          envelope: path.envelopeId
          account: path.accountId
      - text: Get page {page} of document {document} in envelope {envelope} at max width {max_width}.
        slots:
          page: path.pageNumber
          document: path.documentId
          envelope: path.envelopeId
          max_width: query.max_width
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image'].put
  update:
    x-apievangelist-phrasing:
      intent: Rotate a page image in an envelope
      effect: write
      questions:
      - Can I rotate a sideways page in an envelope document?
      - How do I turn a page image left or right?
      instructions:
      - text: Rotate page {page} of document {document} in envelope {envelope} to the {rotate}, account {account}.
        slots:
          page: path.pageNumber
          document: path.documentId
          envelope: path.envelopeId
          rotate: requestBody.rotate
          account: path.accountId
      - text: Turn page {page} of document {document} in envelope {envelope} {rotate} so it reads upright.
        slots:
          page: path.pageNumber
          document: path.documentId
          envelope: path.envelopeId
          rotate: requestBody.rotate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/notification'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an envelope's reminder and expiration settings
      effect: read
      questions:
      - What reminders and expiration are set on an envelope?
      - When will an envelope expire if nobody signs it?
      instructions:
      - text: Get the reminder and expiration settings for envelope {envelope} in account {account}.
        slots:
          envelope: path.envelopeId
          account: path.accountId
      - text: Show when envelope {envelope} expires.
        slots:
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/notification'].put
  update:
    x-apievangelist-phrasing:
      intent: Set reminders and expiration on an envelope
      effect: write
      questions:
      - How do I add automatic reminders to an envelope that's already been created?
      - Can I reset an envelope's expiration back to the account defaults?
      instructions:
      - text: Set reminders {reminders} on envelope {envelope} in account {account}.
        slots:
          reminders: requestBody.reminders
          envelope: path.envelopeId
          account: path.accountId
      - text: Change the expiration of envelope {envelope} to {expirations}.
        slots:
          envelope: path.envelopeId
          expirations: requestBody.expirations
      - text: 'Make envelope {envelope} use account default reminders: {useAccountDefaults}.'
        slots:
          envelope: path.envelopeId
          useAccountDefaults: requestBody.useAccountDefaults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recipient's initials image
      effect: read
      questions:
      - How do I retrieve the initials image a recipient used on an envelope?
      - Can I get a signer's initials image without the surrounding frame?
      instructions:
      - text: Get the initials image for recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Get recipient {recipient}'s initials on envelope {envelope} with chrome set to {include_chrome}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          include_chrome: query.include_chrome
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image'].put
  update:
    x-apievangelist-phrasing:
      intent: Set initials image for an accountless signer
      effect: write
      questions:
      - Can I upload an initials image for a signer who doesn't have an account?
      - What image formats and sizes are allowed for a signer's initials upload?
      instructions:
      - text: Upload an initials image for recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Set the initials image for accountless signer {recipient} on envelope {envelope}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signer's signature information
      effect: read
      questions:
      - What signature details are recorded for a signer on an envelope?
      - Can I look up signature info for a sign-in-person recipient?
      instructions:
      - text: Get signature information for recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Show how signer {recipient} signed envelope {envelope}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signer's signature image
      effect: read
      questions:
      - How do I download the signature image a signer applied?
      - Can I get the signature image with the frame and ID around it?
      instructions:
      - text: Get the signature image of recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Download recipient {recipient}'s signature image on envelope {envelope} with chrome {include_chrome}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          include_chrome: query.include_chrome
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image'].put
  update:
    x-apievangelist-phrasing:
      intent: Set signature image for an accountless signer
      effect: write
      questions:
      - Can I provide a signature image for a signer without an account?
      - Is there a file size limit when uploading a signer's signature image?
      instructions:
      - text: Upload a signature image for recipient {recipient} on envelope {envelope}, account {account}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
          account: path.accountId
      - text: Set the signature image for accountless signer {recipient} on envelope {envelope}.
        slots:
          recipient: path.recipientId
          envelope: path.envelopeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/envelopes/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Get status for a list of envelope IDs
      effect: read
      questions:
      - How do I check status for a long list of envelope IDs by sending them in the request body?
      - Can I look up envelope statuses by transaction ID in bulk?
      instructions:
      - text: Get statuses for envelopes {envelopeIds} in account {account} sent in the request body.
        slots:
          envelopeIds: requestBody.envelopeIds
          account: path.accountId
      - text: Look up envelope statuses for transactions {transactionIds} in account {account}.
        slots:
          transactionIds: requestBody.transactionIds
          account: path.accountId
      method: generated
      generated: '2026-10-01'