Act! CRM · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/act-geographics-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/geographics/phonenumber/masks/{id}'].delete
$.paths['/api/geographics/contact-geolocation'].get
$.paths['/api/geographics/phonenumber/countries'].get
$.paths['/api/geographics/phonenumber/masks'].get
$.paths['/api/geographics/phonenumber/default-masks/{id}'].put

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 Geographics API
  version: 1.0.0
extends: openapi/act-geographics-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/geographics/phonenumber/masks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a phone number mask
      effect: destructive
      questions:
      - Can I remove a phone format mask I don't use?
      - What happens when a phone number mask is deleted?
      instructions:
      - text: Delete phone number mask {id}.
        slots:
          id: path.id
      - text: Remove the phone format mask {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/geographics/contact-geolocation'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact geolocation codes
      effect: read
      questions:
      - Where are my contacts located, as geolocation codes?
      - Can I get latitude and longitude codes for contacts?
      instructions:
      - text: List contact geolocation codes.
      - text: Show the geolocation codes for my contacts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/geographics/phonenumber/countries'].get
  update:
    x-apievangelist-phrasing:
      intent: List countries with phone formats
      effect: read
      questions:
      - Which countries have phone format masks available?
      - Can I filter the phone-format country list with OData?
      instructions:
      - text: List countries that have phone format masks.
      - text: Show every country with a phone number format.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/geographics/phonenumber/masks'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone number masks
      effect: read
      questions:
      - What phone number masks are defined?
      - Can I force the phone format mask cache to refresh while listing?
      instructions:
      - text: List the phone number masks.
      - text: Show phone format masks with cache refresh set to {refresh}.
        slots:
          refresh: query.refresh
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/geographics/phonenumber/default-masks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the default phone number mask
      effect: write
      questions:
      - Can I make one phone format the default for new numbers?
      - What changes the default phone mask?
      instructions:
      - text: Make phone mask {id} the default.
        slots:
          id: path.id
      - text: Set {id} as the default phone number format.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'