Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Secondary Contacts API

8 actions 8 updates phrasing extends openapi/act-secondarycontacts-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 8

$.info
$.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].get
$.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].put
$.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].delete
$.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].patch
$.paths['/api/contacts/{contactId}/secondary-contacts'].get
$.paths['/api/contacts/{contactId}/secondary-contacts'].post
$.paths['/api/contacts/{contactId}/secondary-contacts/{id}/promote'].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 Secondary Contacts API
  version: 1.0.0
extends: openapi/act-secondarycontacts-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: 7
- target: $.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a secondary contact
      effect: read
      questions:
      - How do I look up one secondary contact under a primary contact?
      - Can I get a secondary contact's phone numbers in international format?
      instructions:
      - text: Fetch secondary contact {id} under contact {contactId}.
        slots:
          id: path.id
          contactId: path.contactId
      - text: Show secondary contact {id} of contact {contactId} with phones in {phoneFormat} format.
        slots:
          id: path.id
          contactId: path.contactId
          phoneFormat: query.phoneFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a secondary contact
      effect: write
      questions:
      - How do I overwrite an entire secondary contact record?
      - Can I resend a full secondary contact to change its job title and email?
      instructions:
      - text: Replace secondary contact {id} under {contactId} with name {fullName} and email {emailAddress}.
        slots:
          id: path.id
          contactId: path.contactId
          fullName: requestBody.fullName
          emailAddress: requestBody.emailAddress
      - text: Do a full update of secondary contact {id} on {contactId} with job title {jobTitle}.
        slots:
          id: path.id
          contactId: path.contactId
          jobTitle: requestBody.jobTitle
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secondary contact
      effect: destructive
      questions:
      - How do I remove an assistant or secondary contact from a primary contact?
      - Does deleting a secondary contact affect the primary contact?
      instructions:
      - text: Delete secondary contact {id} from contact {contactId}.
        slots:
          id: path.id
          contactId: path.contactId
      - text: Remove the secondary person {id} listed under {contactId}.
        slots:
          id: path.id
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{contactId}/secondary-contacts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a few fields on a secondary contact
      effect: write
      questions:
      - Can I update only a secondary contact's mobile number?
      - How do I change just the email on a secondary contact?
      instructions:
      - text: Set the mobile phone of secondary contact {id} under {contactId} to {mobilePhone}.
        slots:
          id: path.id
          contactId: path.contactId
          mobilePhone: requestBody.mobilePhone
      - text: Patch secondary contact {id} on {contactId} so the email is {emailAddress}.
        slots:
          id: path.id
          contactId: path.contactId
          emailAddress: requestBody.emailAddress
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{contactId}/secondary-contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a contact's secondary contacts
      effect: read
      questions:
      - Who are the secondary contacts listed under a primary contact?
      - Can I filter a contact's secondary contacts with OData?
      instructions:
      - text: List the secondary contacts of contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Show everyone filed as a secondary contact under {contactId}.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{contactId}/secondary-contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a secondary contact
      effect: write
      questions:
      - How do I add an assistant as a secondary contact on someone's record?
      - What details can I store on a new secondary contact?
      instructions:
      - text: Add {firstName} {lastName} as a secondary contact under {contactId}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          contactId: path.contactId
      - text: Create a secondary contact on {contactId} with email {emailAddress} and title {jobTitle}.
        slots:
          contactId: path.contactId
          emailAddress: requestBody.emailAddress
          jobTitle: requestBody.jobTitle
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contacts/{contactId}/secondary-contacts/{id}/promote'].put
  update:
    x-apievangelist-phrasing:
      intent: Promote a secondary contact to primary
      effect: write
      questions:
      - How do I turn a secondary contact into a full primary contact?
      - Can I promote someone filed under another contact to their own record?
      instructions:
      - text: Promote secondary contact {id} under {contactId} to a primary contact.
        slots:
          id: path.id
          contactId: path.contactId
      - text: Make secondary contact {id} of {contactId} a standalone contact.
        slots:
          id: path.id
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'