Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Sender API

5 actions 5 updates phrasing extends openapi/conga-email-sender-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['/api/email/v1/emails'].post
$.paths['/api/email/v1/emails/bulk'].post
$.paths['/api/email/v1/emails/domain/verify'].get
$.paths['/api/email/v2/emails/bulk'].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 Sender API
  version: 1.0.0
extends: openapi/conga-email-sender-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['/api/email/v1/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a single email
      effect: write
      questions:
      - How do I send one email to a recipient through Conga?
      - Can I add CC, BCC and attachments to an individual email?
      instructions:
      - text: Send an email to {to} with subject {subject}.
        slots:
          to: requestBody.To
          subject: requestBody.Subject
      - text: Email {to} from {from} with the HTML body {html}.
        slots:
          to: requestBody.To
          from: requestBody.From
          html: requestBody.HtmlBody
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/emails/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a mass email from a template
      effect: write
      questions:
      - Can I send the same email template to many recipients at once?
      - What do I need to run a bulk mailing with the original v1 contract?
      instructions:
      - text: Send a bulk mailing using email template {template} from {from}.
        slots:
          template: requestBody.EmailTemplateId
          from: requestBody.From
      - text: Mass-email the recipients in {wrappers} with template {template} via the v1 bulk endpoint.
        slots:
          wrappers: requestBody.EmailRequestWrappers
          template: requestBody.EmailTemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/emails/domain/verify'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a sending email domain
      effect: read
      questions:
      - Is my sending domain verified for outgoing email?
      - Which subdomain checks can I run when verifying a domain?
      instructions:
      - text: Verify the email domain {domain}.
        slots:
          domain: query.domain
      - text: Check verification of subdomain {sub} on {domain}.
        slots:
          sub: query.subDomain
          domain: query.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v2/emails/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a mass email with the v2 contract
      effect: write
      questions:
      - What does the newer v2 bulk email endpoint accept?
      - Can I send a batch of fully separate email requests in one call?
      instructions:
      - text: 'Send these email requests as one v2 bulk batch: {requests}.'
        slots:
          requests: requestBody.EmailRequests
      - text: Use the v2 bulk sender to dispatch {requests}.
        slots:
          requests: requestBody.EmailRequests
      method: generated
      generated: '2026-10-01'