Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Send As API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/send_as/'].get
$.paths['/send_as/'].post
$.paths['/send_as/'].delete
$.paths['/send_as/bulk/'].post
$.paths['/send_as/{id}/'].get
$.paths['/send_as/{id}/'].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 Close Send As API
  version: 1.0.0
extends: openapi/close-send-as-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/send_as/'].get
  update:
    x-apievangelist-phrasing:
      intent: List send-as permissions
      effect: read
      questions:
      - Who is allowed to send emails as me?
      - Which teammates have let me send email on their behalf?
      instructions:
      - text: List everyone allowed to send as me.
      - text: Show the send-as associations where {allowed_user_id} is the allowed user.
        slots:
          allowed_user_id: query.allowed_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/send_as/'].post
  update:
    x-apievangelist-phrasing:
      intent: Let another user send as you
      effect: write
      questions:
      - How do I let a teammate send emails as me?
      - Can I grant one user send-as permission on my account?
      instructions:
      - text: Allow my assistant to send emails as me.
      - text: Create a send-as permission for one teammate.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/send_as/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke send-as for a specific user
      effect: destructive
      questions:
      - Can I revoke send-as permission by naming the user instead of the association?
      - How do I stop a particular teammate from sending as me?
      instructions:
      - text: Revoke send-as permission from user {allowed_user_id}.
        slots:
          allowed_user_id: query.allowed_user_id
      - text: Stop {allowed_user_id} from sending as {allowing_user_id}.
        slots:
          allowed_user_id: query.allowed_user_id
          allowing_user_id: query.allowing_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/send_as/bulk/'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow and disallow many send-as users
      effect: write
      questions:
      - Can I update who can send as me for many users in one request?
      - What's the fastest way to reset my send-as permissions?
      instructions:
      - text: Allow these three users and disallow those two from sending as me in bulk.
      - text: Bulk update my send-as list with the users I want allowed and disallowed.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/send_as/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a send-as association
      effect: read
      questions:
      - How do I look up one send-as association by ID?
      - What does a send-as association record contain?
      instructions:
      - text: Show send-as association {id}.
        slots:
          id: path.id
      - text: Fetch send-as record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/send_as/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a send-as association by ID
      effect: destructive
      questions:
      - Can I delete a send-as permission using its association ID?
      - How do I remove a single send-as record?
      instructions:
      - text: Delete send-as association {id}.
        slots:
          id: path.id
      - text: Remove the send-as record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'