# 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 attribute Value API
  version: 1.0.0
extends: openapi/sendpulse-deal-attribute-value-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: 4
- target: $.paths['/deals/{dealId}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the attribute values set on a deal
      effect: read
      questions:
      - What custom field values are filled in on a particular deal?
      - Can I read a deal's attributes with their types and values?
      instructions:
      - text: Show the attribute values on deal {dealId}.
        slots:
          dealId: path.dealId
      - text: Get every custom field value for deal {dealId}.
        slots:
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an attribute value on a deal
      effect: write
      questions:
      - How do I fill in a custom field on a deal for the first time?
      - Can I add a value for a deal attribute that is currently empty?
      instructions:
      - text: Add value {value} for attribute {attributeId} on deal {dealId}.
        slots:
          value: requestBody.value
          attributeId: requestBody.attributeId
          dealId: path.dealId
      - text: Fill custom field {attributeId} on deal {dealId} with {value}.
        slots:
          attributeId: requestBody.attributeId
          dealId: path.dealId
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/attributes/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List deal attribute values across a pipeline
      effect: read
      questions:
      - Can I pull the attribute values of every deal in one pipeline at once?
      - What custom field values are set across all deals in a pipeline?
      instructions:
      - text: List all deal attribute values in pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Export the custom field values for every deal in pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/attributes/{attributeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite an existing deal attribute value
      effect: write
      questions:
      - How do I change a custom field value that's already set on a deal?
      - Will updating a deal attribute overwrite the old value?
      instructions:
      - text: Change attribute {attributeId} on deal {dealId} to {value}.
        slots:
          attributeId: path.attributeId
          dealId: path.dealId
          value: requestBody.value
      - text: Overwrite the existing value of field {attributeId} on deal {dealId} with {value}.
        slots:
          attributeId: path.attributeId
          dealId: path.dealId
          value: requestBody.value
      method: generated
      generated: '2026-10-01'