Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Import API

5 actions 5 updates phrasing extends openapi/act-import-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/import/mapping/{entityType}'].post
$.paths['/api/s3-import'].post
$.paths['/api/s3-import/{id}'].get
$.paths['/api/s3-import/{id}'].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 Import API
  version: 1.0.0
extends: openapi/act-import-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/import/mapping/{entityType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get field mappings for an import
      effect: read
      questions:
      - Which target fields can my spreadsheet columns map to when importing contacts?
      - How do I match CSV headers to fields before an import?
      instructions:
      - text: Suggest field mappings for headers {headers} when importing {entityType} records.
        slots:
          headers: requestBody.headers
          entityType: path.entityType
      - text: List the {entityType} fields I can map my columns to.
        slots:
          entityType: path.entityType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/s3-import'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an import job
      effect: write
      questions:
      - How do I kick off an import from an uploaded file?
      - Can I tell the import whether my file has a header row?
      instructions:
      - text: Start an import of {entityType} records from {tempFilePath} using mappings {mappings}.
        slots:
          entityType: requestBody.entityType
          tempFilePath: requestBody.tempFilePath
          mappings: requestBody.mappings
      - text: Begin importing file {tempFilePath} with header row set to {hasHeaders}.
        slots:
          tempFilePath: requestBody.tempFilePath
          hasHeaders: requestBody.hasHeaders
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/s3-import/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an import's results
      effect: read
      questions:
      - Did my import finish, and how many records came in?
      - Where can I see the outcome of an import job?
      instructions:
      - text: Show the results of import {id}.
        slots:
          id: path.id
      - text: Check the status of import job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/s3-import/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Import contacts from a prepared CSV
      effect: write
      questions:
      - How do I run the contact import once the CSV is staged?
      - Can I import contact records from a .csv file in one step?
      instructions:
      - text: Run the CSV contact import for import {id}.
        slots:
          id: path.id
      - text: Import the contacts staged under import id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'