# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Account API
  version: 1.0.0
extends: openapi/conga-account-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: 16
- target: $.paths['/api/data/v1/Account'].get
  update:
    x-apievangelist-phrasing:
      intent: List account records
      effect: read
      questions:
      - Which customer accounts are stored in the platform?
      - Can I sort and page account records with a search criteria?
      instructions:
      - text: List account records matching {criteria}.
        slots:
          criteria: query.criteria
      - text: Show accounts sorted by {sortField}, page {pageNumber} of {pageSize}.
        slots:
          sortField: query.sortField
          pageNumber: query.pageNumber
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account record
      effect: write
      questions:
      - How do I add a new customer account?
      - Can I set industry and billing details when creating an account?
      instructions:
      - text: Create account {Name} in industry {Industry}.
        slots:
          Name: requestBody.Name
          Industry: requestBody.Industry
      - text: Insert a new account {Name} with account number {AccountNumber}.
        slots:
          Name: requestBody.Name
          AccountNumber: requestBody.AccountNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many account records
      effect: write
      questions:
      - How do I update a batch of existing accounts in one call?
      - Can I match accounts on a field other than ID during a bulk update?
      instructions:
      - text: Bulk-update these accounts, matching on field {UpdateByField}.
        slots:
          UpdateByField: query.UpdateByField
      - text: Update all these existing account records with optimistic locking {EnforceOptimisticLocking}.
        slots:
          EnforceOptimisticLocking: query.EnforceOptimisticLocking
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many account records
      effect: write
      questions:
      - Can I insert a list of new accounts at once?
      - How do I load many new customer accounts in bulk?
      instructions:
      - text: Bulk-insert these new account records.
      - text: Create all of these accounts and include payloads {IncludeRecordPayloadInResponse}.
        slots:
          IncludeRecordPayloadInResponse: query.IncludeRecordPayloadInResponse
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many account records
      effect: destructive
      questions:
      - Can I delete a batch of accounts in one request?
      - Is it possible to choose a soft or hard delete when bulk-removing accounts?
      instructions:
      - text: Bulk-delete these accounts using delete behaviour {DeleteBehaviour}.
        slots:
          DeleteBehaviour: query.DeleteBehaviour
      - text: Remove the listed account records matched by {DeleteByField}.
        slots:
          DeleteByField: query.DeleteByField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/bulk'].patch
  update:
    x-apievangelist-phrasing:
      intent: Upsert many account records
      effect: write
      questions:
      - How do I insert new accounts and update existing ones in a single call?
      - Can a bulk account upsert match on a field I choose?
      instructions:
      - text: Upsert these account records, matching on {UpdateByField}.
        slots:
          UpdateByField: query.UpdateByField
      - text: Insert or update this batch of accounts in one go.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/by-externalId/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account by external ID
      effect: read
      questions:
      - How do I find an account using the ID from my CRM?
      - Can I look up an account record by its external ID?
      instructions:
      - text: Get the account with external ID {externalId}.
        slots:
          externalId: path.externalId
      - text: Find account record by external key {externalId}.
        slots:
          externalId: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/by-externalId/{externalId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account by external ID
      effect: write
      questions:
      - Can I update an account when I only know its external ID?
      - How do I change an account's billing city using my system's ID?
      instructions:
      - text: Rename the account with external ID {externalId} to {Name}.
        slots:
          externalId: path.externalId
          Name: requestBody.Name
      - text: Set billing city {BillingCity} on account with external ID {externalId}.
        slots:
          BillingCity: requestBody.BillingCity
          externalId: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/by-externalId/{externalId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account by external ID
      effect: destructive
      questions:
      - How do I delete an account using its external ID?
      - Can I soft-delete an account looked up by external key?
      instructions:
      - text: Delete the account with external ID {externalId}.
        slots:
          externalId: path.externalId
      - text: Remove account by external key {externalId} using {deleteBehaviour} delete.
        slots:
          externalId: path.externalId
          deleteBehaviour: query.deleteBehaviour
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query account records
      effect: read
      questions:
      - How can I run a filtered query over accounts and pick which fields come back?
      - Can I group account results or get distinct values?
      instructions:
      - text: Query accounts where {Criteria} and return fields {Select}.
        slots:
          Criteria: requestBody.Criteria
          Select: requestBody.Select
      - text: Run an account query grouped by {GroupBy} with a limit of {Limit}.
        slots:
          GroupBy: requestBody.GroupBy
          Limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/recordtypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List account record types
      effect: read
      questions:
      - What record types are defined for accounts?
      - Which account record types can I choose from?
      instructions:
      - text: List the account record types.
      - text: Show every record type available for accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account record count and storage size
      effect: read
      questions:
      - How many account records do we have in total?
      - How much disk space are account records using?
      instructions:
      - text: Show the total number of account records and their size on disk.
      - text: Get the account object summary.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account by record ID
      effect: read
      questions:
      - What are the details of a specific account record?
      - Can I fetch an account directly by its record ID?
      instructions:
      - text: Get account record {id}.
        slots:
          id: path.id
      - text: Show the full details of account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account by record ID
      effect: write
      questions:
      - How do I change an existing account's annual revenue?
      - Can I mark an account as a partner after it's created?
      instructions:
      - text: Set annual revenue {AnnualRevenue} on account {id}.
        slots:
          AnnualRevenue: requestBody.AnnualRevenue
          id: path.id
      - text: Update account record {id} so IsPartner is {IsPartner}.
        slots:
          id: path.id
          IsPartner: requestBody.IsPartner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/Account/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account by record ID
      effect: destructive
      questions:
      - Can I delete one account record by its ID?
      - Is there a choice between soft and hard delete for a single account?
      instructions:
      - text: Delete account record {id}.
        slots:
          id: path.id
      - text: Remove account {id} with {deleteBehaviour} delete.
        slots:
          id: path.id
          deleteBehaviour: query.deleteBehaviour
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/accounts/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up accounts by name for authoring
      effect: read
      questions:
      - Which accounts match a name in the X-Author add-in?
      - Can X-Author find an account by name for a given org type?
      instructions:
      - text: Find accounts named {name} for org type {OrgType}.
        slots:
          name: path.name
          OrgType: header.OrgType
      - text: Look up account {name} in X-Author.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'