SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Deal contacts API

4 actions 4 updates phrasing extends openapi/sendpulse-deal-contacts-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 4

$.info

$.paths['/deals/{dealId}/contacts'].get

$.paths['/deals/{dealId}/contacts/{contactId}'].post

$.paths['/deals/{dealId}/contacts/{contactId}'].delete

OpenAPI Overlay

# 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 contacts API
  version: 1.0.0
extends: openapi/sendpulse-deal-contacts-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: 3
- target: $.paths['/deals/{dealId}/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contacts in a deal
      effect: read
      questions:
      - Who are the contacts involved in a deal?
      - Can I see every person linked to one deal?
      instructions:
      - text: List contacts in deal {dealId}.
        slots:
          dealId: path.dealId
      - text: Show who is attached to deal {dealId}.
        slots:
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/contacts/{contactId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a contact to a deal
      effect: write
      questions:
      - How do I link an existing contact to a deal?
      - Can I add a second contact to the same deal?
      instructions:
      - text: Add contact {contactId} to deal {dealId}.
        slots:
          contactId: path.contactId
          dealId: path.dealId
      - text: Link contact {contactId} with deal {dealId}.
        slots:
          contactId: path.contactId
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/contacts/{contactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a contact from a deal
      effect: destructive
      questions:
      - Can I take a contact off a deal without deleting the contact?
      - What's the way to unlink someone from a deal?
      instructions:
      - text: Remove contact {contactId} from deal {dealId}.
        slots:
          contactId: path.contactId
          dealId: path.dealId
      - text: Unlink deal {dealId} from contact {contactId}.
        slots:
          dealId: path.dealId
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'