API Evangelist conversational phrasing for ActiveCampaign API v3 Accounts API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ActiveCampaign API v3 Accounts API
  version: 1.0.0
extends: openapi/activecampaign-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 25
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM accounts
      effect: read
      questions:
      - Which company accounts do I have in ActiveCampaign?
      - Can I search my accounts by name and see how many deals each one has?
      instructions:
      - text: List all my CRM accounts.
      - text: Search accounts matching {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CRM account
      effect: write
      questions:
      - How do I add a new company account to my CRM?
      - Can I record a business as an account so contacts and deals can be tied to it?
      instructions:
      - text: 'Create a new account with these details: {account}.'
        slots:
          account: requestBody.account
      - text: Add a company account to the CRM.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one CRM account
      effect: read
      questions:
      - What details are stored on a specific company account?
      - Can I pull up a single account record by its ID?
      instructions:
      - text: Show me account {id}.
        slots:
          id: path.id
      - text: Fetch the full record for CRM account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a CRM account
      effect: write
      questions:
      - How do I change the name or details of an existing account?
      - Can I edit a company account after it has been created?
      instructions:
      - text: Update account {id} with {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Rename or edit the details on company account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CRM account
      effect: destructive
      questions:
      - How do I remove a single company account from my CRM?
      - What happens when I delete one account record?
      instructions:
      - text: Delete account {id}.
        slots:
          id: path.id
      - text: Remove the company account {id} from the CRM.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to an account
      effect: write
      questions:
      - Can I attach a note to a company account?
      - How do I log a comment against an account record?
      instructions:
      - text: Add the note {note} to account {id}.
        slots:
          note: requestBody.note
          id: path.id
      - text: Write a new note on company account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}/notes/{noteid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a note on an account
      effect: write
      questions:
      - Can I edit a note I already left on an account?
      - How do I correct the text of an existing account note?
      instructions:
      - text: Change note {noteid} on account {id} to say {note}.
        slots:
          noteid: path.noteid
          id: path.id
          note: requestBody.note
      - text: Edit existing note {noteid} on company account {id}.
        slots:
          noteid: path.noteid
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/bulk_delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several accounts at once
      effect: destructive
      questions:
      - Can I delete many company accounts in one request?
      - Is there a way to bulk remove accounts by passing a list of IDs?
      instructions:
      - text: Bulk delete the accounts with IDs {ids}.
        slots:
          ids: query.[]ids
      - text: 'Remove all of these accounts in one go: {ids}.'
        slots:
          ids: query.[]ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountContacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact-account associations
      effect: read
      questions:
      - Which contacts are linked to which company accounts?
      - Can I see every account a particular contact is associated with?
      instructions:
      - text: List the account associations for contact {contact}.
        slots:
          contact: query.filters[contact]
      - text: Show all contacts associated with account {account}.
        slots:
          account: query.filters[account]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountContacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a contact to an account
      effect: write
      questions:
      - How do I associate a contact with a company account?
      - Can I record which company a contact works for?
      instructions:
      - text: 'Create an account association: {accountContact}.'
        slots:
          accountContact: requestBody.accountContact
      - text: Link a contact to a company account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountContacts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact-account association
      effect: read
      questions:
      - What does a single contact-to-account link contain?
      - Can I look up one account association by its ID?
      instructions:
      - text: Show account association {id}.
        slots:
          id: path.id
      - text: Fetch the contact-account link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountContacts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact-account association
      effect: write
      questions:
      - Can I change a contact's job title on their account association?
      - How do I edit an existing link between a contact and an account?
      instructions:
      - text: Update account association {id} with {accountContact}.
        slots:
          id: path.id
          accountContact: requestBody.accountContact
      - text: Edit the existing contact-account link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountContacts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a contact from an account
      effect: destructive
      questions:
      - How do I remove a contact from a company account without deleting either?
      - Can I break the link between a contact and their account?
      instructions:
      - text: Delete account association {id}.
        slots:
          id: path.id
      - text: Unlink the contact from the account in association {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldMeta'].get
  update:
    x-apievangelist-phrasing:
      intent: List account custom fields
      effect: read
      questions:
      - What custom fields are defined for company accounts?
      - Can I limit how many account custom field definitions come back?
      instructions:
      - text: List all account custom field definitions.
      - text: Show the first {limit} account custom fields.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldMeta'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new account custom field
      effect: write
      questions:
      - How do I add a custom field to my account records?
      - Can I create a new field like industry or tier for company accounts?
      instructions:
      - text: 'Create an account custom field: {accountCustomFieldMetum}.'
        slots:
          accountCustomFieldMetum: requestBody.accountCustomFieldMetum
      - text: Add a new custom field definition for accounts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldMeta/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account custom field definition
      effect: read
      questions:
      - What type and options does a given account custom field have?
      - Can I look up one account custom field definition by ID?
      instructions:
      - text: Show account custom field {id}.
        slots:
          id: path.id
      - text: Get the definition of account field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldMeta/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account custom field definition
      effect: write
      questions:
      - Can I rename an account custom field or change its options?
      - How do I edit the definition of an existing account field?
      instructions:
      - text: Update account custom field {id} with {accountCustomFieldMetum}.
        slots:
          id: path.id
          accountCustomFieldMetum: requestBody.accountCustomFieldMetum
      - text: Change the label on account field definition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldMeta/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account custom field
      effect: destructive
      questions:
      - How do I remove a custom field I no longer use on accounts?
      - Can I drop an account custom field definition entirely?
      instructions:
      - text: Delete account custom field {id}.
        slots:
          id: path.id
      - text: Remove the account field definition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldData'].get
  update:
    x-apievangelist-phrasing:
      intent: List account custom field values
      effect: read
      questions:
      - What custom field values are stored on a particular account?
      - Can I see every account custom field value filtered by account?
      instructions:
      - text: List the custom field values for account {customerAccountId}.
        slots:
          customerAccountId: query.filters[customerAccountId]
      - text: Show all stored account custom field values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldData'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a custom field value on an account
      effect: write
      questions:
      - How do I fill in a custom field for one account?
      - Can I store a single custom field value against a company account?
      instructions:
      - text: 'Create an account custom field value: {accountCustomFieldDatum}.'
        slots:
          accountCustomFieldDatum: requestBody.accountCustomFieldDatum
      - text: Set one custom field value on an account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldData/bulkCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk set account custom field values
      effect: write
      questions:
      - Can I create many account custom field values in a single call?
      - Is there a bulk way to populate custom fields across accounts?
      instructions:
      - text: 'Bulk create these account custom field values: {values}.'
        slots:
          values: requestBody.array
      - text: Populate custom field values for many accounts at once.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldData/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account custom field value
      effect: read
      questions:
      - What value is stored in one specific account custom field entry?
      - Can I fetch a single account field value by its ID?
      instructions:
      - text: Show account custom field value {id}.
        slots:
          id: path.id
      - text: Get the stored account field value {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldData/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one account custom field value
      effect: write
      questions:
      - How do I change a single custom field value on an account?
      - Can I overwrite one account field value I set earlier?
      instructions:
      - text: Update account custom field value {id} with {accountCustomFieldDatum}.
        slots:
          id: path.id
          accountCustomFieldDatum: requestBody.accountCustomFieldDatum
      - text: Change the stored value of account field entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldData/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear an account custom field value
      effect: destructive
      questions:
      - Can I delete a custom field value from an account without removing the field?
      - How do I clear one account field value?
      instructions:
      - text: Delete account custom field value {id}.
        slots:
          id: path.id
      - text: Clear the account field entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accountCustomFieldData/bulkUpdate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk update account custom field values
      effect: write
      questions:
      - Can I update many existing account custom field values in one request?
      - Is there a bulk edit for account field values I already set?
      instructions:
      - text: 'Bulk update these existing account custom field values: {values}.'
        slots:
          values: requestBody.array
      - text: Change custom field values across many accounts in one call.
      method: generated
      generated: '2026-09-26'