# 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 Deal Attributes API
  version: 1.0.0
extends: openapi/sendpulse-deal-attributes-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: 5
- target: $.paths['/pipelines/{pipelineId}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List deal attribute definitions in a pipeline
      effect: read
      questions:
      - Which custom deal fields are defined for a sales pipeline?
      - Can I see the attribute types configured on a pipeline?
      instructions:
      - text: List the deal attributes defined for pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Show the custom deal field definitions in pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new deal attribute on a pipeline
      effect: write
      questions:
      - How do I add a custom field to deals in one pipeline?
      - Can I make a new deal attribute mandatory with a set of options?
      instructions:
      - text: Create a deal attribute {name} of type {type} in pipeline {pipelineId}.
        slots:
          name: requestBody.name
          type: requestBody.type
          pipelineId: path.pipelineId
      - text: Add a mandatory {type} deal field {name} to pipeline {pipelineId} with options {options}.
        slots:
          type: requestBody.type
          name: requestBody.name
          pipelineId: path.pipelineId
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}/attributes/{attributeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a pipeline's deal attribute definition
      effect: write
      questions:
      - How do I rename a custom deal field in a pipeline?
      - Can I change the display order of a deal attribute definition?
      instructions:
      - text: Rename deal attribute {attributeId} in pipeline {pipelineId} to {name} at position {order}.
        slots:
          attributeId: path.attributeId
          pipelineId: path.pipelineId
          name: requestBody.name
          order: requestBody.order
      - text: Set the status of pipeline {pipelineId} field {attributeId} to {status}, keeping name {name} and order {order}.
        slots:
          pipelineId: path.pipelineId
          attributeId: path.attributeId
          status: requestBody.status
          name: requestBody.name
          order: requestBody.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}/attributes/{attributeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deal attribute definition from a pipeline
      effect: destructive
      questions:
      - How do I remove a custom deal field from a pipeline for good?
      - Can I delete an attribute definition that no deal in the pipeline should use anymore?
      instructions:
      - text: Delete deal attribute definition {attributeId} from pipeline {pipelineId}.
        slots:
          attributeId: path.attributeId
          pipelineId: path.pipelineId
      - text: Remove the custom field {attributeId} from pipeline {pipelineId}.
        slots:
          attributeId: path.attributeId
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/attributes/{attributeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attribute from a single deal
      effect: destructive
      questions:
      - How do I clear a custom field from one deal without touching the pipeline definition?
      - Can I strip an attribute off a specific deal?
      instructions:
      - text: Remove attribute {attributeId} from deal {dealId}.
        slots:
          attributeId: path.attributeId
          dealId: path.dealId
      - text: Clear field {attributeId} on deal {dealId} only.
        slots:
          attributeId: path.attributeId
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'