API Evangelist conversational phrasing for Live Direct Marketing Online Custom Objects API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Custom Objects API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-custom-objects-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: 10
- target: $.paths['/api/custom-objects/defs'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom object definitions
      effect: read
      questions:
      - Which custom object types have we defined?
      - Can I search custom object definitions and show only active ones?
      instructions:
      - text: List custom object definitions matching {search}.
        slots:
          search: query.search
      - text: Show custom object types where active is {isActive}, page {page}.
        slots:
          isActive: query.isActive
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/defs'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new custom object type
      effect: write
      questions:
      - How do I add a new custom object type to the CRM?
      - Can I model my own entity like Projects alongside contacts and companies?
      instructions:
      - text: Create a custom object definition called Projects.
      - text: Define a new custom object type with its fields.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/defs/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object definition
      effect: read
      questions:
      - What fields does a custom object type have?
      - How do I look up one custom object definition by slug?
      instructions:
      - text: Show the custom object definition {slug}.
        slots:
          slug: path.slug
      - text: Fetch the schema of custom object type {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/defs/{slug}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object definition
      effect: destructive
      questions:
      - How do I remove a custom object type I no longer use?
      - Can I delete an entire custom object definition?
      instructions:
      - text: Delete custom object definition {slug}.
        slots:
          slug: path.slug
      - text: Remove the {slug} custom object type.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/defs/{slug}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object definition
      effect: write
      questions:
      - How do I add a field to an existing custom object type?
      - Can I deactivate a custom object definition without deleting it?
      instructions:
      - text: Update custom object definition {slug}.
        slots:
          slug: path.slug
      - text: Add a status field to custom object type {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/{slug}/records'].get
  update:
    x-apievangelist-phrasing:
      intent: List records of a custom object
      effect: read
      questions:
      - What records exist for one of my custom object types?
      - How do I page through custom object records?
      instructions:
      - text: List records of custom object {slug}.
        slots:
          slug: path.slug
      - text: Show page {page} of {slug} records, {pageSize} per page.
        slots:
          page: query.page
          slug: path.slug
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/{slug}/records'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a record to a custom object
      effect: write
      questions:
      - How do I add a new entry to a custom object?
      - Can I create a custom object record with an external id?
      instructions:
      - text: Create a new {slug} record.
        slots:
          slug: path.slug
      - text: Add a record to custom object {slug} with these field values.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/{slug}/records/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object record
      effect: read
      questions:
      - How do I fetch one custom object record by its id?
      - Can I look up a custom object record by its external id?
      instructions:
      - text: Get record {id} of custom object {slug}.
        slots:
          id: path.id
          slug: path.slug
      - text: Look up the {slug} record with external id {id}.
        slots:
          slug: path.slug
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/{slug}/records/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object record
      effect: destructive
      questions:
      - How do I remove a single custom object record?
      - Can I delete one entry from a custom object without touching its definition?
      instructions:
      - text: Delete record {id} from custom object {slug}.
        slots:
          id: path.id
          slug: path.slug
      - text: Remove the {slug} entry {id}.
        slots:
          slug: path.slug
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-objects/{slug}/records/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object record
      effect: write
      questions:
      - How do I edit the fields of an existing custom object record?
      - Can I change just one value on a custom object entry?
      instructions:
      - text: Update record {id} of custom object {slug}.
        slots:
          id: path.id
          slug: path.slug
      - text: Change the status on {slug} record {id} to done.
        slots:
          slug: path.slug
          id: path.id
      method: generated
      generated: '2026-10-01'