Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Profile API

5 actions 5 updates phrasing extends openapi/conga-email-profile-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/email-profiles'].post

$.paths['/api/email/v1/email-profiles/{name}'].get

$.paths['/api/email/v1/email-profiles/{name}'].put

$.paths['/api/email/v1/email-profiles/{name}'].delete

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 Email Profile API
  version: 1.0.0
extends: openapi/conga-email-profile-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/email-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email profile
      effect: write
      questions:
      - What do I need to set up a new sender email profile?
      - Can I give an email profile a display name different from its address?
      instructions:
      - text: Create email profile {name} sending from {address}.
        slots:
          name: requestBody.Name
          address: requestBody.EmailAddress
      - text: Add a sender profile with display name {display}.
        slots:
          display: requestBody.DisplayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-profiles/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email profile by name
      effect: read
      questions:
      - What sender address does a named email profile use?
      - How do I look up an email profile's settings?
      instructions:
      - text: Get email profile {name}.
        slots:
          name: path.name
      - text: Show the settings of sender profile {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-profiles/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email profile
      effect: write
      questions:
      - Can I change the sender address on an existing email profile?
      - How do I rename the display name of an email profile?
      instructions:
      - text: Update email profile {name}.
        slots:
          name: path.name
      - text: Set the sender address of profile {name} to {address}.
        slots:
          name: path.name
          address: requestBody.EmailAddress
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/v1/email-profiles/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email profile
      effect: destructive
      questions:
      - Can I remove a sender email profile I no longer use?
      - Is deleting an email profile permanent?
      instructions:
      - text: Delete email profile {name}.
        slots:
          name: path.name
      - text: Remove the sender profile {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'