Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.whatsapp Messages API

6 actions 6 updates phrasing extends openapi/close-activities-whatsapp-messages-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Close's API. It is a proposal applied on top of the contract, not a document Close publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/activity/whatsapp_message/'].get

$.paths['/activity/whatsapp_message/'].post

$.paths['/activity/whatsapp_message/{id}/'].get

$.paths['/activity/whatsapp_message/{id}/'].put

$.paths['/activity/whatsapp_message/{id}/'].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 Close Activities.whatsapp Messages API
  version: 1.0.0
extends: openapi/close-activities-whatsapp-messages-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/activity/whatsapp_message/'].get
  update:
    x-apievangelist-phrasing:
      intent: List WhatsApp message activities
      effect: read
      questions:
      - Which WhatsApp messages have been logged for a lead?
      - Can I find the logged record for a specific WhatsApp message ID?
      instructions:
      - text: List WhatsApp messages for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Find the WhatsApp activity with external ID {external_whatsapp_message_id}.
        slots:
          external_whatsapp_message_id: query.external_whatsapp_message_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/whatsapp_message/'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a WhatsApp message
      effect: write
      questions:
      - How do I sync a WhatsApp conversation into a lead's timeline?
      - Can a logged WhatsApp message show up in the inbox?
      instructions:
      - text: Log WhatsApp message {external_whatsapp_message_id} saying {message_markdown} on lead {lead_id}.
        slots:
          external_whatsapp_message_id: requestBody.external_whatsapp_message_id
          message_markdown: requestBody.message_markdown
          lead_id: requestBody.lead_id
      - text: Record an inbound WhatsApp message from {remote_phone} for contact {contact_id}.
        slots:
          remote_phone: requestBody.remote_phone
          contact_id: requestBody.contact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/whatsapp_message/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single WhatsApp message
      effect: read
      questions:
      - How can I view one logged WhatsApp message?
      - Where do I see a WhatsApp message's phone numbers and direction?
      instructions:
      - text: Show WhatsApp message activity {id}.
        slots:
          id: path.id
      - text: Fetch logged WhatsApp message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/whatsapp_message/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a logged WhatsApp message
      effect: write
      questions:
      - What if a WhatsApp message was edited after I logged it?
      - Can I change the text of a WhatsApp activity?
      instructions:
      - text: Update WhatsApp message {id} to read {message_markdown}.
        slots:
          id: path.id
          message_markdown: requestBody.message_markdown
      - text: Edit the logged WhatsApp message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/whatsapp_message/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a logged WhatsApp message
      effect: destructive
      questions:
      - When a message is deleted in WhatsApp, how do I remove it here too?
      - Can I delete a WhatsApp activity from a lead?
      instructions:
      - text: Delete WhatsApp message activity {id}.
        slots:
          id: path.id
      - text: Remove WhatsApp message {id} from the timeline.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'