Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Reminder API

5 actions 5 updates phrasing extends openapi/conga-reminder-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/cs-packages/{packageId}/reminders'].get
$.paths['/v1/cs-packages/{packageId}/reminders'].put
$.paths['/v1/cs-packages/{packageId}/reminders'].post
$.paths['/v1/cs-packages/{packageId}/reminders'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Sign Reminder API
  version: 1.0.0
extends: openapi/conga-reminder-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['/v1/cs-packages/{packageId}/reminders'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's reminder schedule
      effect: read
      questions:
      - What reminder schedule is set on a signing package?
      - How often will signers be reminded for this package?
      instructions:
      - text: Show the reminder schedule for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Get reminders configured on package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/reminders'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a package's existing reminder schedule
      effect: write
      questions:
      - Can I change the reminder interval on a package that already has a schedule?
      - Why can't I edit reminders on a package that is already sent?
      instructions:
      - text: Change reminders on package {packageId} to every {intervalInDays} days.
        slots:
          packageId: path.packageId
          intervalInDays: requestBody.intervalInDays
      - text: Update package {packageId} reminders to repeat {repetitionsCount} times.
        slots:
          packageId: path.packageId
          repetitionsCount: requestBody.repetitionsCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/reminders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reminder schedule for a package
      effect: write
      questions:
      - How do I add signer reminders to a package before sending it?
      - Can I delay the first reminder by a few days?
      instructions:
      - text: Create a reminder schedule on package {packageId} starting after {startInDaysDelay} days.
        slots:
          packageId: path.packageId
          startInDaysDelay: requestBody.startInDaysDelay
      - text: Add reminders to package {packageId} every {intervalInDays} days, {repetitionsCount} times.
        slots:
          packageId: path.packageId
          intervalInDays: requestBody.intervalInDays
          repetitionsCount: requestBody.repetitionsCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/reminders'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a package's reminder schedule
      effect: destructive
      questions:
      - Can I stop all reminders for a package?
      - What call removes a package's reminder schedule?
      instructions:
      - text: Delete the reminder schedule on package {packageId}.
        slots:
          packageId: path.packageId
      - text: Remove all reminders from package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'