Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Notification API

6 actions 6 updates phrasing extends openapi/conga-notification-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 6

$.info

$.paths['/v1/cs-packages/{packageId}/documents/{documentId}/approvals/{approvalId}/mobile_notification'].post

$.paths['/v1/cs-packages/{packageId}/notifications'].post

$.paths['/v1/cs-packages/{packageId}/roles/{roleId}/notifications'].post

$.paths['/v1/cs-packages/{packageId}/roles/{roleId}/sms_notification'].post

$.paths['/v1/cs-sms/resend'].post

OpenAPI Overlay

# 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 Notification API
  version: 1.0.0
extends: openapi/conga-notification-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: 5
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/approvals/{approvalId}/mobile_notification'].post
  update:
    x-apievangelist-phrasing:
      intent: Send myself a mobile signing link for an approval
      effect: write
      questions:
      - Can I send myself a link to sign a specific approval on my phone?
      - How do I get a mobile-device signing link for one signature block?
      instructions:
      - text: Send me a mobile signing link for approval {approvalId} on document {documentId} in package {packageId}.
        slots:
          approvalId: path.approvalId
          documentId: path.documentId
          packageId: path.packageId
      - text: Text my phone the signing link for approval {approvalId} of document {documentId}, package {packageId}.
        slots:
          approvalId: path.approvalId
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend the signing email to a signer
      effect: write
      questions:
      - How do I resend the signing invitation email to a signer who lost it?
      - Can I add a custom message when re-sending a notification?
      instructions:
      - text: Resend the signing notification for package {packageId} to {email}.
        slots:
          packageId: path.packageId
          email: requestBody.email
      - text: Email {email} again about package {packageId} with the note {message}.
        slots:
          email: requestBody.email
          packageId: path.packageId
          message: requestBody.message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend notification to a role's signers
      effect: write
      questions:
      - How do I re-notify every signer linked to one role of a package?
      - Can I resend the invitation to a specific recipient role rather than by email?
      instructions:
      - text: Resend the notification to the signers of role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Re-notify recipient role {roleId} on package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/sms_notification'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS signing notification to a role
      effect: write
      questions:
      - How do I text a signing reminder to the signers of a role?
      - Can I send the SMS notification for an in-person signing session?
      instructions:
      - text: Send an SMS notification to role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Text role {roleId} on package {packageId} with in-person set to {inPerson}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
          inPerson: query.inPerson
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-sms/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a signer's SMS verification code
      effect: write
      questions:
      - My signer didn't get their SMS authentication code. Can I resend it?
      - How do I trigger a new SMS code using the signer's login token?
      instructions:
      - text: Resend the SMS code for login token {loginToken}.
        slots:
          loginToken: query.loginToken
      - text: Send the signer a fresh SMS verification code.
      method: generated
      generated: '2026-10-01'