Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Sync Data API

5 actions 5 updates phrasing extends openapi/act-sync-data-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 5

$.info
$.paths['/api/sync-data/search-contacts-by-business-email'].post
$.paths['/api/sync-data/search-synced-external-ids'].post
$.paths['/api/sync-data/search-synced-calendar-uids'].post
$.paths['/api/email-integration-cache-refresh'].post

OpenAPI Overlay

Raw ↑
# 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 Sync Data API
  version: 1.0.0
extends: openapi/act-sync-data-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: 4
- target: $.paths['/api/sync-data/search-contacts-by-business-email'].post
  update:
    x-apievangelist-phrasing:
      intent: Find contact IDs by business email
      effect: read
      questions:
      - Can I look up contact IDs from a list of business emails?
      - Which contacts match these work email addresses?
      instructions:
      - text: Find the contacts with these business emails.
      - text: Look up contact IDs by business email.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sync-data/search-synced-external-ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Find already-synced external IDs
      effect: read
      questions:
      - Which external IDs have already been synced?
      - Can I check whether records from my other system already exist?
      instructions:
      - text: Find which of these external IDs already exist.
      - text: Check for previously synced external identifiers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sync-data/search-synced-calendar-uids'].post
  update:
    x-apievangelist-phrasing:
      intent: Find synced calendar UIDs
      effect: read
      questions:
      - Which calendar UIDs are already synced, and what external IDs map to them?
      - Can I check existing calendar identifiers before syncing events?
      instructions:
      - text: Find the synced calendar UIDs and their external IDs.
      - text: Check which calendar identifiers already exist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-integration-cache-refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh my email integration cache
      effect: write
      questions:
      - How do I refresh the email integration cache for my user?
      - Is there a way to reset stale email integration data?
      instructions:
      - text: Refresh my email integration cache.
      - text: Rebuild the email integration cache for the current user.
      method: generated
      generated: '2026-10-01'