SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Custom Tab API

7 actions 7 updates phrasing extends openapi/sendpulse-custom-tab-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['/custom-tab'].get
$.paths['/custom-tab'].post
$.paths['/custom-tab/{customTabId}'].put
$.paths['/custom-tab/{customTabId}'].delete
$.paths['/custom-tab/{customTabId}/relation'].post
$.paths['/custom-tab/{customTabId}/relation'].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 SendPulse CRM Public Custom Tab API
  version: 1.0.0
extends: openapi/sendpulse-custom-tab-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['/custom-tab'].get
  update:
    x-apievangelist-phrasing:
      intent: List my custom tabs
      effect: read
      questions:
      - What custom tabs have I set up in the CRM?
      - Can I see all the custom tabs configured for my user?
      instructions:
      - text: List all my custom tabs.
      - text: Show the custom tabs on my CRM account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-tab'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom tab
      effect: write
      questions:
      - How do I add a new custom tab to group attributes on a deal or contact card?
      - Can I create a custom tab tied to a specific entity type?
      instructions:
      - text: Create a custom tab named {name}.
        slots:
          name: requestBody.name
      - text: Add a custom tab {name} for {entityType} records.
        slots:
          name: requestBody.name
          entityType: requestBody.entityType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-tab/{customTabId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename, reorder or hide a custom tab
      effect: write
      questions:
      - Can I change the order of my custom tabs?
      - How do I hide a custom tab without deleting it?
      instructions:
      - text: Rename custom tab {customTabId} to {name}.
        slots:
          customTabId: path.customTabId
          name: requestBody.name
      - text: Move custom tab {customTabId} to position {order}.
        slots:
          customTabId: path.customTabId
          order: requestBody.order
      - text: Set visibility of custom tab {customTabId} to {isVisible}.
        slots:
          customTabId: path.customTabId
          isVisible: requestBody.isVisible
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-tab/{customTabId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom tab
      effect: destructive
      questions:
      - How do I get rid of a custom tab I no longer need?
      - Can I delete a custom tab permanently?
      instructions:
      - text: Delete custom tab {customTabId}.
        slots:
          customTabId: path.customTabId
      - text: Remove the custom tab {customTabId} entirely.
        slots:
          customTabId: path.customTabId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-tab/{customTabId}/relation'].post
  update:
    x-apievangelist-phrasing:
      intent: Link attributes to a custom tab
      effect: write
      questions:
      - How do I place an attribute inside one of my custom tabs?
      - Can I attach several attributes to a custom tab at once?
      instructions:
      - text: Add attribute {entityId} to custom tab {customTabId}.
        slots:
          entityId: requestBody.entityId
          customTabId: path.customTabId
      - text: Attach attributes {entityIds} to custom tab {customTabId}.
        slots:
          entityIds: requestBody.entityIds
          customTabId: path.customTabId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-tab/{customTabId}/relation'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink attributes from a custom tab
      effect: destructive
      questions:
      - How do I take an attribute out of a custom tab without deleting the tab?
      - Can I detach several attributes from a custom tab in one call?
      instructions:
      - text: Remove attribute {entityId} from custom tab {customTabId}.
        slots:
          entityId: requestBody.entityId
          customTabId: path.customTabId
      - text: Detach attributes {entityIds} from custom tab {customTabId}.
        slots:
          entityIds: requestBody.entityIds
          customTabId: path.customTabId
      method: generated
      generated: '2026-10-01'