Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoho Crm Settings API

214 actions 214 updates phrasing extends openapi/zoho-crm-settings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Zoho CRM's API. It is a proposal applied on top of the contract, not a document Zoho CRM publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 214 · first 16 shown; the file carries all of them

$.info
$.paths['/settings/appointment_preferences'].get
$.paths['/settings/appointment_preferences'].put
$.paths['/settings/automation/assignment_rules'].get
$.paths['/settings/automation/assignment_rules/{id}'].get
$.paths['/settings/audit_log_export'].get
$.paths['/settings/audit_log_export'].post
$.paths['/settings/audit_log_export/{id}'].get
$.paths['/settings/business_hours'].get
$.paths['/settings/business_hours'].put
$.paths['/settings/business_hours'].post
$.paths['/settings/automation/cadences'].get
$.paths['/settings/call_preferences'].get
$.paths['/settings/call_preferences'].put
$.paths['/settings/custom_views'].get
$.paths['/settings/custom_views/{id}'].get

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 Zoho Crm Settings API
  version: 1.0.0
extends: openapi/zoho-crm-settings-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: 213
- target: $.paths['/settings/appointment_preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get appointment preferences
      effect: read
      questions:
      - What are my current appointment preferences for deal creation and job sheets?
      - Can I see whether completing an appointment creates a deal automatically?
      instructions:
      - text: Show my appointment preferences.
      - text: Show my appointment preferences including {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/appointment_preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Update appointment preferences
      effect: write
      questions:
      - Can I change how appointments create deals when they are marked complete?
      - Is it possible to hide the job sheet on appointments through the API?
      instructions:
      - text: Update my appointment preferences to {appointment_preferences}.
        slots:
          appointment_preferences: requestBody.appointment_preferences
      - text: Turn off automatic deal creation in my appointment preferences.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/assignment_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List assignment rules
      effect: read
      questions:
      - Which assignment rules are set up to route new records to owners?
      - Can I list only the assignment rules for the Leads module?
      instructions:
      - text: List all assignment rules.
      - text: List the assignment rules for the {module} module.
        slots:
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/assignment_rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an assignment rule
      effect: read
      questions:
      - What criteria and owners does a specific assignment rule use?
      - Can I see the inner details of one assignment rule by its ID?
      instructions:
      - text: Show assignment rule {id} in the {module} module.
        slots:
          id: path.id
          module: query.module
      - text: Get assignment rule {id} for {module} with inner details.
        slots:
          id: path.id
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/audit_log_export'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit log export jobs
      effect: read
      questions:
      - What audit log exports have been run and are any still in progress?
      - Where can I find the download link for audit log exports I already requested?
      instructions:
      - text: List my audit log export jobs.
      - text: Show every audit log export and its status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/audit_log_export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an audit log export
      effect: write
      questions:
      - Can I export the audit log for a date range to review admin changes?
      - How do I start a job that exports audit logs matching certain criteria?
      instructions:
      - text: Start an audit log export with criteria {criteria}.
        slots:
          criteria: requestBody.audit_log_export
      - text: Export the audit log using {criteria} as the filter.
        slots:
          criteria: requestBody.audit_log_export
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/audit_log_export/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audit log export job
      effect: read
      questions:
      - Is a particular audit log export finished yet?
      - What is the status of the audit log export job I just created?
      instructions:
      - text: Check audit log export job {id}.
        slots:
          id: path.id
      - text: Get the download details for audit log export {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/business_hours'].get
  update:
    x-apievangelist-phrasing:
      intent: Get business hours
      effect: read
      questions:
      - What working days and hours is my CRM organization set to?
      - Which timezone do our configured business hours use?
      instructions:
      - text: Show our business hours configuration.
      - text: Get the organization's working days and hours.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/business_hours'].put
  update:
    x-apievangelist-phrasing:
      intent: Update business hours
      effect: write
      questions:
      - Can I change our existing business hours to add Saturday as a working day?
      - Is it possible to switch the timezone on business hours we already set up?
      instructions:
      - text: Update our existing business hours to {business_hours}.
        slots:
          business_hours: requestBody.business_hours
      - text: Change the business hours timezone and working days per {business_hours}.
        slots:
          business_hours: requestBody.business_hours
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/business_hours'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up business hours
      effect: write
      questions:
      - How do I define business hours for an organization that has none configured yet?
      - Can I create a first business hours setup with working days and a timezone?
      instructions:
      - text: Create a business hours configuration of {business_hours}.
        slots:
          business_hours: requestBody.business_hours
      - text: Set up new business hours for the org using {business_hours}.
        slots:
          business_hours: requestBody.business_hours
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/cadences'].get
  update:
    x-apievangelist-phrasing:
      intent: List cadences
      effect: read
      questions:
      - Which sales cadences are active right now?
      - Can I find a cadence by name within a module?
      instructions:
      - text: List all cadences.
      - text: List active cadences in {module}.
        slots:
          module: query.module
      - text: Find the cadence named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/call_preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get call preferences
      effect: read
      questions:
      - What from-number and to-number settings are used for my calls?
      - Where do I check my personal call preference in the CRM?
      instructions:
      - text: Show my call preferences.
      - text: Get the from and to number call settings for my user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/call_preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Update call preferences
      effect: write
      questions:
      - Can I change which number shows as the from number on my calls?
      - Is it possible to update my user's call preference programmatically?
      instructions:
      - text: Update my call preferences to {call_preferences}.
        slots:
          call_preferences: requestBody.call_preferences
      - text: Change my call from-number setting per {call_preferences}.
        slots:
          call_preferences: requestBody.call_preferences
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/custom_views'].get
  update:
    x-apievangelist-phrasing:
      intent: List a module's custom views
      effect: read
      questions:
      - What saved custom views exist for the Deals module?
      - Can I filter the list of custom views in a module?
      instructions:
      - text: List custom views for {module}.
        slots:
          module: query.module
      - text: List custom views in {module} matching {filters}.
        slots:
          module: query.module
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/custom_views/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom view
      effect: read
      questions:
      - Which criteria and columns make up one specific custom view?
      - Can I fetch a single custom view by its ID?
      instructions:
      - text: Show custom view {id} in {module}.
        slots:
          id: path.id
          module: query.module
      - text: Get custom view {id} of {module} with inner details.
        slots:
          id: path.id
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/custom_views/actions/change_sort'].put
  update:
    x-apievangelist-phrasing:
      intent: Change custom view sort order (ID in body)
      effect: write
      questions:
      - Can I change the sort order of several custom views in one request?
      - Is there a way to set a view's sort field when the view ID is passed in the body?
      instructions:
      - text: Change the sort order of custom views in {module} to {custom_views}.
        slots:
          module: query.module
          custom_views: requestBody.custom_views
      - text: Re-sort {module} views using the body payload {custom_views}.
        slots:
          module: query.module
          custom_views: requestBody.custom_views
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/custom_views/{id}/actions/change_sort'].put
  update:
    x-apievangelist-phrasing:
      intent: Change one custom view's sort order
      effect: write
      questions:
      - How do I change the sort column of one custom view by its ID in the URL?
      - Can I make a specific view sort by created time descending?
      instructions:
      - text: Change the sort order of custom view {id} in {module} to {custom_views}.
        slots:
          id: path.id
          module: query.module
          custom_views: requestBody.custom_views
      - text: Sort view {id} of {module} per {custom_views}.
        slots:
          id: path.id
          module: query.module
          custom_views: requestBody.custom_views
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/data_sharing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get data sharing settings
      effect: read
      questions:
      - What are the organization-wide data sharing permissions for each module?
      - Is the Contacts module set to private or public read/write?
      instructions:
      - text: Show our data sharing settings.
      - text: Get the default record access for every module.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/data_sharing'].put
  update:
    x-apievangelist-phrasing:
      intent: Update data sharing settings
      effect: write
      questions:
      - Can I make a module private so only record owners and managers see it?
      - Is it possible to change default sharing rules for modules?
      instructions:
      - text: Update data sharing settings to {data_sharing}.
        slots:
          data_sharing: requestBody.data_sharing
      - text: Change module access levels per {data_sharing}.
        slots:
          data_sharing: requestBody.data_sharing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/duplicate_check_preference'].get
  update:
    x-apievangelist-phrasing:
      intent: Get duplicate check preference
      effect: read
      questions:
      - Which fields does a module use to detect duplicate records?
      - Is duplicate checking turned on for the Leads module?
      instructions:
      - text: Show the duplicate check preference for {module}.
        slots:
          module: query.module
      - text: Get duplicate detection settings of the {module} module.
        slots:
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/duplicate_check_preference'].put
  update:
    x-apievangelist-phrasing:
      intent: Update duplicate check preference
      effect: write
      questions:
      - Can I change which fields are compared when checking a module for duplicates?
      - Is it possible to adjust an existing duplicate check setup?
      instructions:
      - text: Update the duplicate check preference for {module} to {duplicate_check_preference}.
        slots:
          module: query.module
          duplicate_check_preference: requestBody.duplicate_check_preference
      - text: Change duplicate matching fields in {module} per {duplicate_check_preference}.
        slots:
          module: query.module
          duplicate_check_preference: requestBody.duplicate_check_preference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/duplicate_check_preference'].post
  update:
    x-apievangelist-phrasing:
      intent: Create duplicate check preference
      effect: write
      questions:
      - How do I enable duplicate checking for a module that has none?
      - Can I set up a new duplicate rule that matches on email?
      instructions:
      - text: Create a duplicate check preference for {module} with {duplicate_check_preference}.
        slots:
          module: query.module
          duplicate_check_preference: requestBody.duplicate_check_preference
      - text: Turn on duplicate checking in {module} using {duplicate_check_preference}.
        slots:
          module: query.module
          duplicate_check_preference: requestBody.duplicate_check_preference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/duplicate_check_preference'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove duplicate check preference
      effect: destructive
      questions:
      - Can I switch off duplicate checking for a module entirely?
      - What happens if I remove the duplicate check preference from a module?
      instructions:
      - text: Delete the duplicate check preference for {module}.
        slots:
          module: query.module
      - text: Remove duplicate detection from the {module} module.
        slots:
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/email_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates
      effect: read
      questions:
      - Which email templates exist for the Leads module?
      - Can I sort email templates by last modified time and page through them?
      instructions:
      - text: List my email templates.
      - text: List email templates for {module} in category {category}.
        slots:
          module: query.module
          category: query.category
      - text: Show email templates sorted by {sort_by}, page {page}.
        slots:
          sort_by: query.sort_by
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/field_updates'].get
  update:
    x-apievangelist-phrasing:
      intent: List field update actions
      effect: read
      questions:
      - Which field update automation actions are configured?
      - Can I page through all field update actions sorted by name?
      instructions:
      - text: List all field update actions.
      - text: List field update actions sorted by {sort_by}.
        slots:
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/field_updates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a field update action
      effect: write
      questions:
      - Can I create an action that sets a field value when a workflow fires?
      - How do I add a field update that blueprints or approvals can trigger?
      instructions:
      - text: Create a field update action {field_updates}.
        slots:
          field_updates: requestBody.field_updates
      - text: Add a new field update automation with {field_updates}.
        slots:
          field_updates: requestBody.field_updates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/field_updates'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several field update actions
      effect: destructive
      questions:
      - Can I remove multiple field update actions at once?
      - Is there a bulk delete for field update automations?
      instructions:
      - text: Delete field update actions {ids}.
        slots:
          ids: query.ids
      - text: Remove the field updates with IDs {ids} in one go.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/field_updates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field update action
      effect: read
      questions:
      - What field and value does a specific field update action set?
      - Can I see the full configuration of one field update by ID?
      instructions:
      - text: Show field update action {id}.
        slots:
          id: path.id
      - text: Get field update {id} with inner details {include_inner_details}.
        slots:
          id: path.id
          include_inner_details: query.include_inner_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/field_updates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field update action
      effect: write
      questions:
      - Can I change the value an existing field update action writes?
      - Is it possible to rename a field update automation?
      instructions:
      - text: Update field update action {id} with {field_updates}.
        slots:
          id: path.id
          field_updates: requestBody.field_updates
      - text: Change the value set by field update {id} to {field_updates}.
        slots:
          id: path.id
          field_updates: requestBody.field_updates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/automation/field_updates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field update action
      effect: destructive
      questions:
      - Can I delete one field update action I no longer use?
      - What happens to workflows when a single field update is removed?
      instructions:
      - text: Delete field update action {id}.
        slots:
          id: path.id
      - text: Remove the field update with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a module's fields
      effect: read
      questions:
      - What fields exist in the Contacts module and what are their data types?
      - Can I list only the unused fields of a module?
      instructions:
      - text: List the fields in {module}, including {include}.
        slots:
          module: query.module
          include: query.include
      - text: List {type} fields in the {module} module with {include}.
        slots:
          type: query.type
          module: query.module
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create custom fields
      effect: write
      questions:
      - Can I add a new custom field to the Deals module?
      - How do I create several custom fields in a module at once?
      instructions:
      - text: Create custom fields {fields} in {module}.
        slots:
          fields: requestBody.fields
          module: query.module
      - text: Add a new custom field to {module}.
        slots:
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fields'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several custom fields
      effect: write
      questions:
      - Can I update multiple custom fields in one request with IDs in the body?
      - Is there a bulk way to relabel custom fields in a module?
      instructions:
      - text: Update custom fields in {module} with {fields}.
        slots:
          module: query.module
          fields: requestBody.fields
      - text: Bulk-edit {module} custom fields using {fields}.
        slots:
          module: query.module
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fields/{fieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one field's metadata
      effect: read
      questions:
      - What are the properties of a specific field in a module?
      - Can I look up a single field's metadata by its field ID?
      instructions:
      - text: Show field {fieldId} in {module} including {include}.
        slots:
          fieldId: path.fieldId
          module: query.module
          include: query.include
      - text: Get the metadata of field {fieldId} from {module} with {include}.
        slots:
          fieldId: path.fieldId
          module: query.module
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fields/{fieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - Can I delete a custom field that is no longer needed?
      - Why can't a custom field used in workflows or scoring rules be deleted?
      instructions:
      - text: Delete custom field {fieldId} from {module}.
        slots:
          fieldId: path.fieldId
          module: query.module
      - text: Remove field {fieldId} in the {module} module.
        slots:
          fieldId: path.fieldId
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fields/{fieldId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one custom field
      effect: write
      questions:
      - Can I change the label or length of one custom field by its ID?
      - Is it possible to edit a single field's picklist options?
      instructions:
      - text: Update field {fieldId} in {module} with {fields}.
        slots:
          fieldId: path.fieldId
          module: query.module
          fields: requestBody.fields
      - text: Rename custom field {fieldId} in {module}.
        slots:
          fieldId: path.fieldId
          module: query.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fiscal_year'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fiscal year settings
      effect: read
      questions:
      - When does our organization's fiscal year start?
      - Is our CRM using a standard or custom fiscal year?
      instructions:
      - text: Show our fiscal year settings.
      - text: Get the fiscal year start month.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/fiscal_year'].put
  update:
    x-apievangelist-phrasing:
      intent: Update fiscal year settings
      effect: write
      questions:
      - Can an admin change the start month of the fiscal year?
      - Is it possible to switch our fiscal year to a custom one?
      instructions:
      - text: Update the fiscal year to {fiscal_year}.
        slots:
          fiscal_year: requestBody.fiscal_year
      - text: Set the fiscal year start per {fiscal_year}.
        slots:
          fiscal_year: requestBody.fiscal_year
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/emails/actions/from_addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List from email addresses
      effect: read
      questions:
      - Which email addresses am I allowed to send CRM emails from?
      - What sender addresses are available for outgoing email?
      instructions:
      - text: List my available from addresses.
      - text: Show the email addresses I can send from.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/global_picklists'].get
  update:
    x-apievangelist-phrasing:
      intent: List global picklists
      effect: read
      questions:
      - What global picklists are shared across modules?
      - Can I see which modules use each global picklist?
      instructions:
      - text: List all global picklists.
      - text: List global picklists including {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/global_picklists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a global picklist
      effect: write
      questions:
      - Can I create a picklist that several modules can reuse?
      - How do I define a new shared picklist with its values?
      instructions:
      - text: Create global picklist {global_picklists}.
        slots:
          global_picklists: requestBody.global_picklists
      - text: Add a shared picklist defined as {global_picklists}.
        slots:
          global_picklists: requestBody.global_picklists
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/global_picklists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a global picklist
      effect: read
      questions:
      - What values does a particular global picklist contain?
      - How many fields use one specific global picklist?
      instructions:
      - text: Show global picklist {id}.
        slots:
          id: path.id
      - text: Get global picklist {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/global_picklists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a global picklist
      effect: destructive
      questions:
      - Can I delete a global picklist and how long does removal take?
      - Is global picklist deletion asynchronous?
      instructions:
      - text: Delete global picklist {id}.
        slots:
          id: path.id
      - text: Remove the shared picklist with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/global_picklists/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a global picklist
      effect: write
      questions:
      - Can I add or rename values in an existing global picklist?
      - Is it possible to change a global picklist's display label?
      instructions:
      - text: Update global picklist {id} with {global_picklists}.
        slots:
          id: path.id
          global_picklists: requestBody.global_picklists
      - text: Add new values to global picklist {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/global_picklists/{id}/actions/pick_list_values_associations'].get
  update:
    x-apievangelist-phrasing:
      intent: See where a picklist value is used
      effect: read
      questions:
      - Which workflows or blueprints depend on a specific global picklist value?
      - Is a picklist value safe to remove, or is it used in automation?
      instructions:
      - text: Show where value {picklist_value_id} of global picklist {id} is used.
        slots:
          picklist_value_id: query.picklist_value_id
          id: path.id
      - text: List features that reference picklist value {picklist_value_id} in {id}.
        slots:
          picklist_value_id: query.picklist_value_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/inventory_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List inventory templates
      effect: read
      questions:
      - Which inventory templates exist for quotes or invoices?
      - Can I filter inventory templates by category and sort them?
      instructions:
      - text: List my inventory templates.
      - text: List inventory templates for {module} sorted by {sort_by}.
        slots:
          module: query.module
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/layouts/{id}/actions/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a layout
      effect: write
      questions:
      - Can I reactivate a deactivated layout and assign it to profiles?
      - How do I turn a layout back on for a module?
      instructions:
      - text: Activate layout {id} in {module} with {layouts}.
        slots:
          id: path.id
          module: query.module
          layouts: requestBody.layouts
      - text: Re-enable layout {id} of {module} for profiles in {layouts}.
        slots:
          id: path.id
          module: query.module
          layouts: requestBody.layouts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/layouts/{id}/actions/activate'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a layout
      effect: destructive
      questions:
      - Can I deactivate a layout and move its profiles to another layout?
      - What happens to a layout's permissions when it is switched off?
      instructions:
      - text: Deactivate layout {id} in {module} and transfer to {transfer_to}.
        slots:
          id: path.id
          module: query.module
          transfer_to: query.transfer_to
      - text: Turn off layout {id} of {module}, moving its setup to layout {transfer_to}.
        slots:
          id: path.id
          module: query.module
          transfer_to: query.transfer_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a module's layouts
      effect: read
      questions:
      - What layouts does the Deals module have?
      - Can I see the sections and fields of every layout in a module?
      instructions:
      - text: List layouts for {module}.
        slots:
          module: query.module
      - text: List {module} layouts in {mode} mode.
        slots:
          module: query.module
          mode: query.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/layouts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a layout
      effect: read
      questions:
      - What sections and fields are in one specific layout?
      - Can I fetch a single layout by its ID?
      instructions:
      - text: Show layout {id} of {module}.
        slots:
          id: path.id
          module: query.module
      - text: Get layout {id} in {module} including {include}.
        slots:
          id: path.id
          module: query.module
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings/layouts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom layout
      effect: destructive
      questions:
      - Can I delete a custom layout that still has records?
      - Where do records go when their layout is deleted?
      instructions:
      - text: Delete layout {id} from {module}.
        slots:
          id: path.id
          module: query.module
      - text: Delete layout {id} in {module} and move its records to {transfer_to}.
        slots:
          id: path.id
          module: query.module
          transfer_to: query.transfer_to
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/overlays/zoho-crm-settings-api-phrasing-overlay.yaml