Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Delivery Status API

3 actions 3 updates phrasing extends openapi/conga-email-delivery-status-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 3

$.info
$.paths['/api/email/v1/emails/jobs/{jobId}'].get
$.paths['/api/email/v1/emails/status/batch'].post

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 Email Delivery Status API
  version: 1.0.0
extends: openapi/conga-email-delivery-status-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: 2
- target: $.paths['/api/email/v1/emails/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email delivery status by job
      effect: read
      questions:
      - Was the email sent by a particular job delivered?
      - How do I check delivery status using an email job ID?
      instructions:
      - text: Get the delivery status of email job {job}.
        slots:
          job: path.jobId
      - text: Check whether email job {job} was delivered.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/emails/status/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Get email delivery status for recipients
      effect: read
      questions:
      - Which recipients of an email send actually received it?
      - Can I check delivery status for several recipients of one send at once?
      instructions:
      - text: Get delivery status for send {send} to recipients {recipients}.
        slots:
          send: requestBody.EmailSendId
          recipients: requestBody.Recipients
      - text: Check which recipients of email send {send} were delivered.
        slots:
          send: requestBody.EmailSendId
      method: generated
      generated: '2026-10-01'