Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Activity Series API

7 actions 7 updates phrasing extends openapi/act-activityseries-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/api/ActivitySeries/{id}'].get

$.paths['/api/ActivitySeries/{id}'].put

$.paths['/api/ActivitySeries/{id}'].delete

$.paths['/api/ActivitySeries/{id}'].patch

$.paths['/api/ActivitySeries'].get

$.paths['/api/ActivitySeries'].post

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 act.web.api Activity Series API
  version: 1.0.0
extends: openapi/act-activityseries-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: 6
- target: $.paths['/api/ActivitySeries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activity series (deprecated)
      effect: read
      questions:
      - How do I look up a repeating activity series on the legacy ActivitySeries endpoint?
      - What does one series activity record contain?
      instructions:
      - text: Show activity series {id} from the deprecated endpoint.
        slots:
          id: path.id
      - text: Get legacy series activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ActivitySeries/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an activity series (deprecated)
      effect: write
      questions:
      - Can I fully update a series activity on the old ActivitySeries route?
      - Is there a legacy call to overwrite a repeating activity's recurrence?
      instructions:
      - text: Update activity series {id} with recurrence {recurSpec}.
        slots:
          id: path.id
          recurSpec: requestBody.recurSpec
      - text: Overwrite legacy series {id} with subject {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ActivitySeries/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activity series (deprecated)
      effect: destructive
      questions:
      - Does deleting a series activity also remove occurrences I rescheduled?
      - Which legacy call deletes a whole repeating activity series?
      instructions:
      - text: Delete activity series {id}.
        slots:
          id: path.id
      - text: Remove the legacy repeating series {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ActivitySeries/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an activity series (deprecated)
      effect: write
      questions:
      - Can I patch just the location of a series activity on the legacy endpoint?
      - Is partial update supported for repeating activity series?
      instructions:
      - text: Change the location of activity series {id} to {location}.
        slots:
          id: path.id
          location: requestBody.location
      - text: Patch legacy series {id} so its details read {details}.
        slots:
          id: path.id
          details: requestBody.details
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ActivitySeries'].get
  update:
    x-apievangelist-phrasing:
      intent: List activity series (deprecated)
      effect: read
      questions:
      - How do I list all repeating activity series on the old endpoint?
      - Can I filter series activities on the legacy list?
      instructions:
      - text: List all activity series.
      - text: List legacy activity series filtered by {filterBy}.
        slots:
          filterBy: query.filterBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ActivitySeries'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an activity series (deprecated)
      effect: write
      questions:
      - Can I still create a repeating activity through the legacy ActivitySeries route?
      - What does a new series activity need to define its recurrence?
      instructions:
      - text: Create activity series {subject} with recurrence {recurSpec}.
        slots:
          subject: requestBody.subject
          recurSpec: requestBody.recurSpec
      - text: Start a legacy repeating activity {subject} at {startTime}.
        slots:
          subject: requestBody.subject
          startTime: requestBody.startTime
      method: generated
      generated: '2026-10-01'