Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Custom Entities API

6 actions 6 updates phrasing extends openapi/act-custom-entities-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 6

$.info
$.paths['/api/custom/entities/{entityName}/{id}'].get
$.paths['/api/custom/entities/{entityName}/{id}'].put
$.paths['/api/custom/entities/{entityName}/{id}'].delete
$.paths['/api/custom/entities/{entityName}'].get
$.paths['/api/custom/entities/{entityName}'].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 Custom Entities API
  version: 1.0.0
extends: openapi/act-custom-entities-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/custom/entities/{entityName}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom entity record
      effect: read
      questions:
      - How do I fetch one record of a custom entity type?
      - Can I look up a custom object record by its ID?
      instructions:
      - text: Get {entityName} record {id}.
        slots:
          entityName: path.entityName
          id: path.id
      - text: Show custom record {id} of type {entityName}.
        slots:
          entityName: path.entityName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom/entities/{entityName}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a custom entity record at a given ID
      effect: write
      questions:
      - Can I write a custom entity record under an ID I choose?
      - What call puts a custom object record at a specific ID?
      instructions:
      - text: Save {entityName} record with ID {id}.
        slots:
          entityName: path.entityName
          id: path.id
      - text: Put custom record {id} into entity {entityName}.
        slots:
          entityName: path.entityName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom/entities/{entityName}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom entity record
      effect: destructive
      questions:
      - How do I delete a record from a custom entity?
      - Can I permanently remove one custom object record?
      instructions:
      - text: Delete {entityName} record {id}.
        slots:
          entityName: path.entityName
          id: path.id
      - text: Remove custom record {id} from entity {entityName}.
        slots:
          entityName: path.entityName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom/entities/{entityName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a custom entity's records
      effect: read
      questions:
      - Which records exist for one of my custom entities?
      - Can I query a custom entity's data with OData?
      instructions:
      - text: List all {entityName} records.
        slots:
          entityName: path.entityName
      - text: Show the data stored in custom entity {entityName}.
        slots:
          entityName: path.entityName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom/entities/{entityName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom entity record
      effect: write
      questions:
      - How do I add a new record to a custom entity?
      - Can I create a custom object record and let the system assign its ID?
      instructions:
      - text: Create a new {entityName} record.
        slots:
          entityName: path.entityName
      - text: Add a record to custom entity {entityName}.
        slots:
          entityName: path.entityName
      method: generated
      generated: '2026-10-01'