SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Company Attributes API

5 actions 5 updates phrasing extends openapi/sendpulse-company-attributes-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 5

$.info
$.paths['/companies/attributes'].get
$.paths['/companies/attributes'].post
$.paths['/companies/attributes/{attribute}'].put
$.paths['/companies/attributes/{attribute}'].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 Company Attributes API
  version: 1.0.0
extends: openapi/sendpulse-company-attributes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/companies/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List company attribute definitions
      effect: read
      questions:
      - What custom fields are defined for companies in my CRM?
      - Can I see the types and options of every company attribute?
      instructions:
      - text: List the company attributes defined in my CRM.
      - text: Show all custom company fields.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company attribute
      effect: write
      questions:
      - How do I add a new custom field for companies?
      - Can I make a company attribute mandatory with preset options?
      instructions:
      - text: Create a company attribute named {name}.
        slots:
          name: requestBody.name
      - text: Add a {type} company field {name} with options {options}.
        slots:
          type: requestBody.type
          name: requestBody.name
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/companies/attributes/{attribute}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a company attribute definition
      effect: write
      questions:
      - How do I rename a custom company field?
      - Can I reorder company attributes or change their status?
      instructions:
      - text: Rename company attribute {attribute} to {name} at position {order}.
        slots:
          attribute: path.attribute
          name: requestBody.name
          order: requestBody.order
      - text: Set company field {attributeId} status to {status}, keeping name {name} and order {order}.
        slots:
          attributeId: path.attributeId
          status: requestBody.status
          name: requestBody.name
          order: requestBody.order
      method: generated
      generated: '2026-10-02'
- target: $.paths['/companies/attributes/{attribute}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company attribute
      effect: destructive
      questions:
      - How do I remove a custom company field I don't need?
      - Can I delete a company attribute definition?
      instructions:
      - text: Delete company attribute {attributeId}.
        slots:
          attributeId: path.attributeId
      - text: Remove the custom company field {attribute}.
        slots:
          attribute: path.attribute
      method: generated
      generated: '2026-10-02'