API Evangelist conversational phrasing for Live Direct Marketing Online Activities API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Activities API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-activities-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: 5
- target: $.paths['/api/activities/feed'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the unified CRM event feed
      effect: read
      questions:
      - What has happened across my CRM lately, emails and activities together?
      - Can I filter the event feed to inbound emails in a date range?
      instructions:
      - text: Show the event feed of type {type} from {dateFrom} to {dateTo}.
        slots:
          type: query.type
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Search the CRM event feed for {search} on {entityType} records, page {page} of size {pageSize}.
        slots:
          search: query.search
          entityType: query.entityType
          page: query.page
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List activities for a lead, contact or company
      effect: read
      questions:
      - Which calls, tasks and notes are logged against a lead?
      - Can I see a company's activities filtered by type?
      instructions:
      - text: List activities for lead {leadId}.
        slots:
          leadId: query.leadId
      - text: Show {type} activities for contact {contactId} at company {companyId}.
        slots:
          type: query.type
          contactId: query.contactId
          companyId: query.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a call, task or note
      effect: write
      questions:
      - How do I log a call I just had with a contact?
      - Can I create a task with a due date on a lead?
      instructions:
      - text: Log a {type} for contact {contactId} with subject {subject}.
        slots:
          type: requestBody.type
          contactId: requestBody.contactId
          subject: requestBody.subject
      - text: Create a {type} on lead {leadId} due {dueDate}.
        slots:
          type: requestBody.type
          leadId: requestBody.leadId
          dueDate: requestBody.dueDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/activities/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activity
      effect: destructive
      questions:
      - Can I delete a note or task I logged by mistake?
      - Is removing an activity from a record permanent?
      instructions:
      - text: Delete activity {id}.
        slots:
          id: path.id
      - text: Remove the logged call or note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/activities/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or complete an activity
      effect: write
      questions:
      - How do I mark a task as done?
      - Can I change the due date on an existing activity?
      instructions:
      - text: Mark activity {id} as done.
        slots:
          id: path.id
      - text: Move the due date of activity {id} to {dueDate}.
        slots:
          id: path.id
          dueDate: requestBody.dueDate
      method: generated
      generated: '2026-10-01'