SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Contact email addresses API

4 actions 4 updates phrasing extends openapi/sendpulse-contact-email-addresses-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['/contacts/{contactId}/emails'].post

$.paths['/contacts/{contactId}/emails/{emailId}'].put

$.paths['/contacts/{contactId}/emails/{emailId}'].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 Contact email addresses API
  version: 1.0.0
extends: openapi/sendpulse-contact-email-addresses-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['/contacts/{contactId}/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email address to a CRM contact
      effect: write
      questions:
      - How do I add another email address to a contact?
      - Can a CRM contact have more than one email?
      instructions:
      - text: Add emails {emails} to contact {contactId}.
        slots:
          emails: requestBody.emails
          contactId: path.contactId
      - text: Give contact {contactId} an additional email address.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/emails/{emailId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a contact's email address
      effect: write
      questions:
      - Can I correct a typo in a contact's email?
      - Is it possible to replace one of a contact's email addresses?
      instructions:
      - text: Change email {emailId} on contact {contactId} to {email}.
        slots:
          emailId: path.emailId
          contactId: path.contactId
          email: requestBody.email
      - text: Update contact {contactId}'s address {emailId} to {email}.
        slots:
          contactId: path.contactId
          emailId: path.emailId
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/emails/{emailId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an email address from a contact
      effect: destructive
      questions:
      - Can I delete an old email address from a contact?
      - What's the way to remove one email from a CRM contact?
      instructions:
      - text: Remove email {emailId} from contact {contactId}.
        slots:
          emailId: path.emailId
          contactId: path.contactId
      - text: Delete contact {contactId}'s address {emailId}.
        slots:
          contactId: path.contactId
          emailId: path.emailId
      method: generated
      generated: '2026-10-01'