SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Contacts messengers API

4 actions 4 updates phrasing extends openapi/sendpulse-contacts-messengers-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}/messengers'].post

$.paths['/contacts/{contactId}/messengers/{messengerId}'].put

$.paths['/contacts/{contactId}/messengers/{messengerId}'].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 Contacts messengers API
  version: 1.0.0
extends: openapi/sendpulse-contacts-messengers-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}/messengers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a messenger account to a contact
      effect: write
      questions:
      - How do I link a messenger login to a CRM contact?
      - Can I mark a messenger as the contact's main chatbot channel?
      instructions:
      - text: Add messenger type {typeId} with login {login} to contact {contactId}.
        slots:
          typeId: requestBody.typeId
          login: requestBody.login
          contactId: path.contactId
      - text: Link {login} on messenger {typeId} to contact {contactId} as main chatbot {isMainChatbot}.
        slots:
          login: requestBody.login
          typeId: requestBody.typeId
          contactId: path.contactId
          isMainChatbot: requestBody.isMainChatbot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/messengers/{messengerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact's messenger account
      effect: write
      questions:
      - Can I change the login of a messenger already on a contact?
      - Does updating a contact's messenger overwrite existing values?
      instructions:
      - text: Update messenger {messengerId} of contact {contactId} to type {typeId} with login {login}.
        slots:
          messengerId: path.messengerId
          contactId: path.contactId
          typeId: requestBody.typeId
          login: requestBody.login
      - text: Change the login on contact {contactId} messenger {messengerId} to {login}, type {typeId}.
        slots:
          contactId: path.contactId
          messengerId: path.messengerId
          login: requestBody.login
          typeId: requestBody.typeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/messengers/{messengerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a messenger account from a contact
      effect: destructive
      questions:
      - Can I unlink a messenger from a contact?
      - What's the way to delete a contact's messenger login?
      instructions:
      - text: Remove messenger {messengerId} from contact {contactId}.
        slots:
          messengerId: path.messengerId
          contactId: path.contactId
      - text: Unlink messenger {messengerId} on contact {contactId}.
        slots:
          messengerId: path.messengerId
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'