SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Manager Settings API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/manager-settings/sections'].get
$.paths['/manager-settings/managers'].get
$.paths['/manager-settings'].post
$.paths['/manager-settings/{settingId}'].put
$.paths['/manager-settings/{settingId}'].delete
$.paths['/manager-settings/{sectionId}'].get

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 SendPulse CRM Public Manager Settings API
  version: 1.0.0
extends: openapi/sendpulse-managersettings-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: 6
- target: $.paths['/manager-settings/sections'].get
  update:
    x-apievangelist-phrasing:
      intent: List manager settings sections
      effect: read
      questions:
      - What sections can managers be assigned to?
      - Which manager settings categories exist?
      instructions:
      - text: List all manager settings sections.
      - text: Show the sections available for manager assignment.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/manager-settings/managers'].get
  update:
    x-apievangelist-phrasing:
      intent: List all managers
      effect: read
      questions:
      - Who are all the managers in my account?
      - Can I get every manager available for assignment?
      instructions:
      - text: List all managers.
      - text: Show every manager I can assign to a section.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/manager-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign managers to a section
      effect: write
      questions:
      - How do I assign managers to a section?
      - Can I add several responsible users to one category at once?
      instructions:
      - text: Assign managers {responsibleIds} to section {sectionId}.
        slots:
          responsibleIds: requestBody.responsibleIds
          sectionId: requestBody.sectionId
      - text: Create a manager setting for section {sectionId}.
        slots:
          sectionId: requestBody.sectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/manager-settings/{settingId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change managers on a manager setting
      effect: write
      questions:
      - Can I change which managers belong to an existing manager setting?
      - Is it possible to swap the section on a manager assignment?
      instructions:
      - text: Update manager setting {settingId} to managers {responsibleIds}.
        slots:
          settingId: path.settingId
          responsibleIds: requestBody.responsibleIds
      - text: Move manager setting {settingId} to section {sectionId}.
        slots:
          settingId: path.settingId
          sectionId: requestBody.sectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/manager-settings/{settingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove managers from a manager setting
      effect: destructive
      questions:
      - Can I remove certain managers from a section assignment?
      - What's the way to delete managers from a category setting?
      instructions:
      - text: Remove managers {responsibleIds} from setting {settingId}.
        slots:
          responsibleIds: requestBody.responsibleIds
          settingId: path.settingId
      - text: Delete manager setting {settingId}'s managers.
        slots:
          settingId: path.settingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/manager-settings/{sectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List managers assigned to a section
      effect: read
      questions:
      - Which managers are assigned to a given section?
      - Can I see who handles one particular category?
      instructions:
      - text: List managers in section {sectionId}.
        slots:
          sectionId: path.sectionId
      - text: Show who is responsible for section {sectionId}.
        slots:
          sectionId: path.sectionId
      method: generated
      generated: '2026-10-01'