# 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' - target: $.paths['/settings/layouts/{layoutId}/map_dependency'].get update: x-apievangelist-phrasing: intent: List field dependencies in a layout effect: read questions: - Which picklist fields depend on other fields in a layout? - Can I list all parent-child field dependencies for a layout? instructions: - text: List field dependencies for layout {layoutId} in {module}. slots: layoutId: path.layoutId module: query.module - text: Show dependencies in layout {layoutId} of {module}, page {page}. slots: layoutId: path.layoutId module: query.module page: query.page method: generated generated: '2026-09-26' - target: $.paths['/settings/layouts/{layoutId}/map_dependency'].post update: x-apievangelist-phrasing: intent: Create a field dependency effect: write questions: - Can I make a child picklist's options depend on a parent field? - How do I add a new field dependency to a layout? instructions: - text: Create field dependency {map_dependency} in layout {layoutId} of {module}. slots: map_dependency: requestBody.map_dependency layoutId: path.layoutId module: query.module - text: Add a parent-child picklist mapping to layout {layoutId} in {module}. slots: layoutId: path.layoutId module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/layouts/{layoutId}/map_dependency/{dependencyId}'].get update: x-apievangelist-phrasing: intent: Get a field dependency effect: read questions: - Which child values map to each parent value in one field dependency? - Can I inspect a single field dependency by ID? instructions: - text: Show dependency {dependencyId} in layout {layoutId} of {module}. slots: dependencyId: path.dependencyId layoutId: path.layoutId module: query.module - text: Get the value mappings of dependency {dependencyId} on layout {layoutId} in {module}. slots: dependencyId: path.dependencyId layoutId: path.layoutId module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/layouts/{layoutId}/map_dependency/{dependencyId}'].put update: x-apievangelist-phrasing: intent: Update a field dependency effect: write questions: - Can I change which child picklist values a parent value allows? - Is it possible to remove one mapping from an existing field dependency? instructions: - text: Update dependency {dependencyId} in layout {layoutId} of {module} with {map_dependency}. slots: dependencyId: path.dependencyId layoutId: path.layoutId module: query.module map_dependency: requestBody.map_dependency - text: Change the picklist mappings of dependency {dependencyId} on layout {layoutId} in {module}. slots: dependencyId: path.dependencyId layoutId: path.layoutId module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/layouts/{layoutId}/map_dependency/{dependencyId}'].delete update: x-apievangelist-phrasing: intent: Delete a field dependency effect: destructive questions: - Can I remove a field dependency so the child picklist shows all values? - Is deleting a field dependency permanent? instructions: - text: Delete dependency {dependencyId} from layout {layoutId} in {module}. slots: dependencyId: path.dependencyId layoutId: path.layoutId module: query.module - text: Remove the parent-child mapping {dependencyId} on layout {layoutId} of {module}. slots: dependencyId: path.dependencyId layoutId: path.layoutId module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/tags/actions/mass_delete'].get update: x-apievangelist-phrasing: intent: Check a tag mass-delete job effect: read questions: - Has my scheduled tag mass-delete job finished? - What is the status of the bulk tag deletion I started? instructions: - text: Check the status of my tag mass delete job. - text: Show progress on the scheduled tag deletion. method: generated generated: '2026-09-26' - target: $.paths['/settings/tags/actions/mass_delete'].post update: x-apievangelist-phrasing: intent: Mass delete tags effect: destructive questions: - Can I delete many tags across several modules in one job? - Is there a bulk way to clean up unused tags? instructions: - text: Schedule a mass delete of tags {mass_delete}. slots: mass_delete: requestBody.mass_delete - text: 'Delete these tags across modules: {mass_delete}.' slots: mass_delete: requestBody.mass_delete method: generated generated: '2026-09-26' - target: $.paths['/settings/modules'].get update: x-apievangelist-phrasing: intent: List CRM modules effect: read questions: - Which modules are available in my CRM, including custom ones? - Can I list only modules that support a particular feature? instructions: - text: List all CRM modules. - text: List modules that support {feature_name}. slots: feature_name: query.feature_name - text: List modules with status {status}. slots: status: query.status method: generated generated: '2026-09-26' - target: $.paths['/settings/modules'].put update: x-apievangelist-phrasing: intent: Update several modules effect: write questions: - Can I relabel multiple modules in a single request? - Is there a bulk way to change module profile assignments? instructions: - text: Update modules with {modules}. slots: modules: requestBody.modules - text: Relabel several modules and their profiles per {modules}. slots: modules: requestBody.modules method: generated generated: '2026-09-26' - target: $.paths['/settings/modules'].post update: x-apievangelist-phrasing: intent: Create a custom module effect: write questions: - Can I create a new custom module through the API? - What permission is needed to add a custom module? instructions: - text: Create custom module {modules}. slots: modules: requestBody.modules - text: Add a new custom module defined as {modules}. slots: modules: requestBody.modules method: generated generated: '2026-09-26' - target: $.paths['/settings/modules/{moduleIdentifier}'].get update: x-apievangelist-phrasing: intent: Get a module's metadata effect: read questions: - What configuration and fields does one module have? - Can I get a module's metadata by its API name? instructions: - text: Show metadata for module {moduleIdentifier}. slots: moduleIdentifier: path.moduleIdentifier - text: Get the configuration of the {moduleIdentifier} module. slots: moduleIdentifier: path.moduleIdentifier method: generated generated: '2026-09-26' - target: $.paths['/settings/modules/{moduleIdentifier}'].put update: x-apievangelist-phrasing: intent: Update one module's labels effect: write questions: - Can I rename a single module's singular and plural labels? - Is it possible to change which profiles can access one module? instructions: - text: Update module {moduleIdentifier} with {modules}. slots: moduleIdentifier: path.moduleIdentifier modules: requestBody.modules - text: Rename the {moduleIdentifier} module labels. slots: moduleIdentifier: path.moduleIdentifier method: generated generated: '2026-09-26' - target: $.paths['/settings/fields/{fieldId}/pick_list_values'].get update: x-apievangelist-phrasing: intent: Get a field's picklist values effect: read questions: - What options are available in a picklist field? - Can I see translated display values for a picklist field? instructions: - text: List picklist values of field {fieldId} in {module}. slots: fieldId: path.fieldId module: query.module - text: Show the dropdown options for field {fieldId} of {module}. slots: fieldId: path.fieldId module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline'].get update: x-apievangelist-phrasing: intent: List pipelines for a layout effect: read questions: - Which deal pipelines are set up for a layout? - What stages does each pipeline in a layout include? instructions: - text: List pipelines for layout {layout_id}. slots: layout_id: query.layout_id - text: Show all sales pipelines on layout {layout_id}. slots: layout_id: query.layout_id method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline'].put update: x-apievangelist-phrasing: intent: Update or delete pipelines (PUT, IDs in body) effect: destructive questions: - Can I update or delete several pipelines at once with a PUT request? - Is there a bulk PUT for changing pipelines on a layout? instructions: - text: Update pipelines on layout {layout_id} with PUT using {pipeline}. slots: layout_id: query.layout_id pipeline: requestBody.pipeline - text: Replace pipeline settings in bulk on layout {layout_id} via PUT with {pipeline}. slots: layout_id: query.layout_id pipeline: requestBody.pipeline method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline'].post update: x-apievangelist-phrasing: intent: Create a pipeline effect: write questions: - Can I add a new sales pipeline to a layout? - How do I create a pipeline with its own stages? instructions: - text: Create pipeline {pipeline} on layout {layout_id}. slots: pipeline: requestBody.pipeline layout_id: query.layout_id - text: Add a new pipeline to layout {layout_id}. slots: layout_id: query.layout_id method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline'].patch update: x-apievangelist-phrasing: intent: Update or delete pipelines (PATCH, IDs in body) effect: destructive questions: - Can I partially update several pipelines using PATCH? - Is there a bulk PATCH to delete pipelines from a layout? instructions: - text: Patch pipelines on layout {layout_id} with {pipeline}. slots: layout_id: query.layout_id pipeline: requestBody.pipeline - text: Partially update pipelines in bulk on layout {layout_id} via PATCH with {pipeline}. slots: layout_id: query.layout_id pipeline: requestBody.pipeline method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline/{id}'].get update: x-apievangelist-phrasing: intent: Get a pipeline effect: read questions: - What stages are in one specific pipeline? - Can I fetch a single pipeline by its ID? instructions: - text: Show pipeline {id} on layout {layout_id}. slots: id: path.id layout_id: query.layout_id - text: Get the stages of pipeline {id} in layout {layout_id}. slots: id: path.id layout_id: query.layout_id method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline/{id}'].put update: x-apievangelist-phrasing: intent: Update or delete one pipeline (PUT by ID) effect: destructive questions: - Can I replace one pipeline's settings with a PUT on its ID? - Is there a PUT to delete a single pipeline by ID? instructions: - text: PUT update pipeline {id} on layout {layout_id} with {pipeline}. slots: id: path.id layout_id: query.layout_id pipeline: requestBody.pipeline - text: Replace the settings of pipeline {id} in layout {layout_id} via PUT. slots: id: path.id layout_id: query.layout_id method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline/{id}'].patch update: x-apievangelist-phrasing: intent: Update or delete one pipeline (PATCH by ID) effect: destructive questions: - Can I patch just the stages of one pipeline by its ID? - Is there a PATCH call to change a single pipeline's name? instructions: - text: Patch pipeline {id} on layout {layout_id} with {pipeline}. slots: id: path.id layout_id: query.layout_id pipeline: requestBody.pipeline - text: Partially update pipeline {id} of layout {layout_id} via PATCH. slots: id: path.id layout_id: query.layout_id method: generated generated: '2026-09-26' - target: $.paths['/settings/pipeline/actions/transfer'].post update: x-apievangelist-phrasing: intent: Transfer deals and delete pipelines effect: destructive questions: - Can I move deals to another pipeline before deleting the old one? - What happens to records when a pipeline is transferred and deleted? instructions: - text: Transfer and delete pipelines on layout {layout_id} per {transfer_pipeline}. slots: layout_id: query.layout_id transfer_pipeline: requestBody.transfer_pipeline - text: Move deals out and remove pipelines using {transfer_pipeline} on layout {layout_id}. slots: layout_id: query.layout_id transfer_pipeline: requestBody.transfer_pipeline method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type'].get update: x-apievangelist-phrasing: intent: List portal user types effect: read questions: - What user types are defined for a customer portal? - Which kinds of portal users can I invite to my portal? instructions: - text: List user types for portal {portal}. slots: portal: path.portal - text: Show all user types in the {portal} portal. slots: portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type'].post update: x-apievangelist-phrasing: intent: Create portal user types effect: write questions: - Can I add a new user type to a portal with its own permissions? - How do I create several portal user types at once? instructions: - text: Create user types {user_type} in portal {portal}. slots: user_type: requestBody.user_type portal: path.portal - text: Add a new user type to the {portal} portal. slots: portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userTypeId}'].get update: x-apievangelist-phrasing: intent: Get a portal user type effect: read questions: - What access does a particular portal user type have? - Can I fetch one portal user type by ID? instructions: - text: Show user type {userTypeId} in portal {portal}. slots: userTypeId: path.userTypeId portal: path.portal - text: Get the permissions of portal user type {userTypeId} on {portal}. slots: userTypeId: path.userTypeId portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userTypeId}'].put update: x-apievangelist-phrasing: intent: Update a portal user type effect: write questions: - Can I change the module permissions of a portal user type? - Is it possible to rename an existing portal user type? instructions: - text: Update user type {userTypeId} in portal {portal} with {user_type}. slots: userTypeId: path.userTypeId portal: path.portal user_type: requestBody.user_type - text: Rename portal user type {userTypeId} on {portal}. slots: userTypeId: path.userTypeId portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userTypeId}'].delete update: x-apievangelist-phrasing: intent: Delete a portal user type effect: destructive questions: - Can I delete a portal user type I no longer need? - Is removing a portal user type permanent? instructions: - text: Delete user type {userTypeId} from portal {portal}. slots: userTypeId: path.userTypeId portal: path.portal - text: Remove portal user type {userTypeId} on {portal}. slots: userTypeId: path.userTypeId portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userType}/users'].get update: x-apievangelist-phrasing: intent: List portal users of a type effect: read questions: - Who are the users of a given type in my portal? - Can I filter portal users and page through them? instructions: - text: List users of type {userType} in portal {portal}. slots: userType: path.userType portal: path.portal - text: List {userType} users on {portal} matching {filters}. slots: userType: path.userType portal: path.portal filters: query.filters method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userType}/users'].delete update: x-apievangelist-phrasing: intent: Remove portal users effect: destructive questions: - Can I remove specific users from a portal user type? - Is there a bulk way to revoke portal users? instructions: - text: Delete portal users {personality_ids} of type {userType} from portal {portal}. slots: personality_ids: query.personality_ids userType: path.userType portal: path.portal - text: Remove all listed {userType} users from the {portal} portal. slots: userType: path.userType portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userType}/users/action/transfer'].post update: x-apievangelist-phrasing: intent: Move portal users to another user type effect: write questions: - Can I move portal users from one user group to another in the same portal? - How do I reassign portal users to a different user type? instructions: - text: Move users {personality_ids} from {userType} to {transfer_To} in portal {portal}. slots: personality_ids: query.personality_ids userType: path.userType transfer_To: query.transfer_To portal: path.portal - text: Transfer portal users {personality_ids} on {portal} from type {userType} to {transfer_To}. slots: personality_ids: query.personality_ids portal: path.portal userType: path.userType transfer_To: query.transfer_To method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status'].post update: x-apievangelist-phrasing: intent: Activate or deactivate a portal user effect: write questions: - Can I deactivate a single portal user without deleting them? - How do I reactivate one portal user's access? instructions: - text: Set portal user {recordId} of type {userType} on {portal} to active {active}. slots: recordId: path.recordId userType: path.userType portal: path.portal active: query.active - text: Deactivate portal user {recordId} in {portal} ({userType}) by setting active to {active}. slots: recordId: path.recordId portal: path.portal userType: path.userType active: query.active method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}/user_type/{userType}/users/actions/change_status'].post update: x-apievangelist-phrasing: intent: Change status of many portal users effect: write questions: - Can I activate or deactivate many portal users at once? - Is there a bulk status change for portal users? instructions: - text: Change status of {userType} users on portal {portal} per {change_status}. slots: userType: path.userType portal: path.portal change_status: requestBody.change_status - text: Bulk deactivate portal users of type {userType} in {portal} using {change_status}. slots: userType: path.userType portal: path.portal change_status: requestBody.change_status method: generated generated: '2026-09-26' - target: $.paths['/settings/portals'].get update: x-apievangelist-phrasing: intent: List portals effect: read questions: - What customer portals does my organization have? - Which portals are set up for end customers? instructions: - text: List our portals. - text: Show all customer portals in the org. method: generated generated: '2026-09-26' - target: $.paths['/settings/portals'].post update: x-apievangelist-phrasing: intent: Create a portal effect: write questions: - Can I create a portal so end customers can access their records? - How do I set up a new customer portal? instructions: - text: Create portal {portals}. slots: portals: requestBody.portals - text: Set up a customer portal with {portals}. slots: portals: requestBody.portals method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}'].get update: x-apievangelist-phrasing: intent: Get a portal effect: read questions: - What are the settings of a specific portal? - Can I fetch one portal's details by name? instructions: - text: Show portal {portal}. slots: portal: path.portal - text: Get the settings of the {portal} portal. slots: portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}'].put update: x-apievangelist-phrasing: intent: Update a portal effect: write questions: - Can I change a portal's settings after it's created? - Is it possible to rename an existing portal? instructions: - text: Update portal {portal} with {portals}. slots: portal: path.portal portals: requestBody.portals - text: Change the settings of portal {portal}. slots: portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/portals/{portal}'].delete update: x-apievangelist-phrasing: intent: Delete a portal effect: destructive questions: - Can I delete a customer portal completely? - What happens to portal access when a portal is removed? instructions: - text: Delete portal {portal}. slots: portal: path.portal - text: Remove the {portal} portal. slots: portal: path.portal method: generated generated: '2026-09-26' - target: $.paths['/settings/profiles'].get update: x-apievangelist-phrasing: intent: List CRM profiles effect: read questions: - What permission profiles exist in my CRM? - Can I filter profiles by type? instructions: - text: List all CRM profiles. - text: List profiles of type {type}. slots: type: query.type method: generated generated: '2026-09-26' - target: $.paths['/settings/profiles/{id}/actions/clone'].post update: x-apievangelist-phrasing: intent: Clone a profile effect: write questions: - Can I copy an existing profile to start a new one? - How do I duplicate a permission profile under a new name? instructions: - text: Clone profile {id}. slots: id: path.id - text: Clone profile {id} as {profiles}. slots: id: path.id profiles: requestBody.profiles method: generated generated: '2026-09-26' - target: $.paths['/settings/profiles/{id}'].get update: x-apievangelist-phrasing: intent: Get a profile effect: read questions: - What permissions does a specific profile grant? - Can I view one profile's details by ID? instructions: - text: Show profile {id}. slots: id: path.id - text: Get the permissions of profile {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/profiles/{id}'].put update: x-apievangelist-phrasing: intent: Update a profile effect: write questions: - Can I change the permissions on an existing profile? - Is it possible to rename a profile? instructions: - text: Update profile {id} with {profiles}. slots: id: path.id profiles: requestBody.profiles - text: Change permissions of profile {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/profiles/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a profile effect: destructive questions: - Can I delete a profile that users are still assigned to? - Where do users go when their profile is deleted? instructions: - text: Delete profile {id} and move its users to {transfer_to_id}. slots: id: path.id transfer_to_id: query.transfer_to_id - text: Remove profile {id}, reassigning users to profile {transfer_to_id}. slots: id: path.id transfer_to_id: query.transfer_to_id method: generated generated: '2026-09-26' - target: $.paths['/settings/record_locking_configurations'].get update: x-apievangelist-phrasing: intent: Get record locking configuration effect: read questions: - Is record locking enabled for a module, and what triggers it? - Which record locking rules are configured for Deals? instructions: - text: Show record locking configuration for {module}. slots: module: query.module - text: Get the lock settings for the {module} module. slots: module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/record_locking_configurations'].put update: x-apievangelist-phrasing: intent: Update record locking (ID in body) effect: write questions: - Can I update record locking settings for a module with the config ID in the body? - Is there a way to change several lock configurations in one request? instructions: - text: Update record locking in {module} with {record_locking_configurations}. slots: module: query.module record_locking_configurations: requestBody.record_locking_configurations - text: Change {module} lock rules in bulk per {record_locking_configurations}. slots: module: query.module record_locking_configurations: requestBody.record_locking_configurations method: generated generated: '2026-09-26' - target: $.paths['/settings/record_locking_configurations'].post update: x-apievangelist-phrasing: intent: Enable record locking for a module effect: write questions: - Can I turn on record locking for a module that has none? - How do I add a record locking configuration? instructions: - text: Create record locking configuration {record_locking_configurations} for {module}. slots: record_locking_configurations: requestBody.record_locking_configurations module: query.module - text: Enable record locking in {module}. slots: module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/record_locking_configurations'].delete update: x-apievangelist-phrasing: intent: Delete record locking configs (by IDs) effect: destructive questions: - Can I delete several record locking configurations by listing their IDs? - Is there a bulk removal for record lock settings? instructions: - text: Delete record locking configurations {ids} in {module}. slots: ids: query.ids module: query.module - text: Remove lock configs {ids} from the {module} module. slots: ids: query.ids module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/record_locking_configurations/{id}'].get update: x-apievangelist-phrasing: intent: Get one record locking config by ID effect: read questions: - Can I fetch a single record locking configuration by its ID? - What does one particular lock configuration contain? instructions: - text: Show record locking configuration {id} in {module}. slots: id: path.id module: query.module - text: Get lock config {id} for {module}. slots: id: path.id module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/record_locking_configurations/{id}'].put update: x-apievangelist-phrasing: intent: Update one record locking config by ID effect: write questions: - Can I update a single lock configuration with its ID in the URL? - Is it possible to change the lock trigger of one specific configuration? instructions: - text: Update record locking configuration {id} in {module} with {record_locking_configurations}. slots: id: path.id module: query.module record_locking_configurations: requestBody.record_locking_configurations - text: Change lock config {id} of {module}. slots: id: path.id module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/record_locking_configurations/{id}'].delete update: x-apievangelist-phrasing: intent: Delete one record locking config by ID effect: destructive questions: - Can I delete one record locking configuration using its ID in the URL? - What happens to locked records when their lock configuration is deleted? instructions: - text: Delete record locking configuration {id} in {module}. slots: id: path.id module: query.module - text: Remove lock config {id} from {module}. slots: id: path.id module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin'].get update: x-apievangelist-phrasing: intent: List recycle bin records effect: read questions: - What records are sitting in the recycle bin? - Can I see deleted records before they are purged? instructions: - text: List records in the recycle bin. - text: Show what's been deleted recently. method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin'].delete update: x-apievangelist-phrasing: intent: Purge matching recycle bin records effect: destructive questions: - Can I permanently delete recycle bin records that match a filter? - Why would a recycle bin purge only partly succeed? instructions: - text: Permanently delete recycle bin records matching {filters}. slots: filters: query.filters - text: Purge recycle bin entries where {filters}. slots: filters: query.filters method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin/actions/restore'].post update: x-apievangelist-phrasing: intent: Restore records from the recycle bin effect: write questions: - Can I restore several deleted records at once? - Is there a way to restore everything in the recycle bin? instructions: - text: Restore recycle bin records {ids}. slots: ids: requestBody.ids - text: Restore deleted records matching {filters}. slots: filters: requestBody.filters - text: 'Restore all recycle bin records: {restore_all_records}.' slots: restore_all_records: requestBody.restore_all_records method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin/actions/count'].get update: x-apievangelist-phrasing: intent: Count recycle bin records effect: read questions: - How many records are in the recycle bin right now? - Can I get a quick total of deleted items? instructions: - text: Count the records in the recycle bin. - text: Give me the recycle bin totals. method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin/actions/empty'].post update: x-apievangelist-phrasing: intent: Empty the recycle bin effect: destructive questions: - Can I permanently clear the entire recycle bin? - Is emptying the recycle bin reversible? instructions: - text: Empty the recycle bin. - text: Permanently delete everything in the recycle bin. method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin/{recordId}/actions/restore'].post update: x-apievangelist-phrasing: intent: Restore one deleted record effect: write questions: - Can I restore a single record I deleted by mistake? - How do I undo the deletion of one record? instructions: - text: Restore recycle bin record {recordId}. slots: recordId: path.recordId - text: Bring back deleted record {recordId}. slots: recordId: path.recordId method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin/{recordId}'].get update: x-apievangelist-phrasing: intent: Get one recycle bin record effect: read questions: - Who deleted a specific record and when? - Can I look up one entry in the recycle bin by ID? instructions: - text: Show recycle bin record {recordId}. slots: recordId: path.recordId - text: Get the deletion details of record {recordId}. slots: recordId: path.recordId method: generated generated: '2026-09-26' - target: $.paths['/settings/recycle_bin/{recordId}'].delete update: x-apievangelist-phrasing: intent: Permanently delete one bin record effect: destructive questions: - Can I purge a single record from the recycle bin for good? - Once a record is removed from the recycle bin, can it come back? instructions: - text: Permanently delete recycle bin record {recordId}. slots: recordId: path.recordId - text: Purge record {recordId} from the recycle bin. slots: recordId: path.recordId method: generated generated: '2026-09-26' - target: $.paths['/settings/related_lists'].get update: x-apievangelist-phrasing: intent: Get related lists configuration effect: read questions: - Which related lists appear on records in a module? - Can I see related lists for one specific layout? instructions: - text: List related lists for {module}. slots: module: query.module - text: Show related lists of {module} on layout {layout_id}. slots: module: query.module layout_id: query.layout_id method: generated generated: '2026-09-26' - target: $.paths['/settings/roles'].get update: x-apievangelist-phrasing: intent: List roles effect: read questions: - What is our CRM role hierarchy? - Which roles exist in the organization? instructions: - text: List all roles. - text: Show the role hierarchy. method: generated generated: '2026-09-26' - target: $.paths['/settings/roles'].put update: x-apievangelist-phrasing: intent: Update several roles effect: write questions: - Can I update multiple roles in one call? - Is there a bulk way to change who roles report to? instructions: - text: Update roles with {roles}. slots: roles: requestBody.roles - text: Bulk-edit role names and reporting lines per {roles}. slots: roles: requestBody.roles method: generated generated: '2026-09-26' - target: $.paths['/settings/roles'].post update: x-apievangelist-phrasing: intent: Create roles effect: write questions: - Can I add a new role under an existing manager role? - How do I create several roles at once? instructions: - text: Create roles {roles}. slots: roles: requestBody.roles - text: 'Add new roles to the hierarchy: {roles}.' slots: roles: requestBody.roles method: generated generated: '2026-09-26' - target: $.paths['/settings/roles/{role}'].get update: x-apievangelist-phrasing: intent: Get a role effect: read questions: - Who does a specific role report to? - Can I fetch one role by its ID? instructions: - text: Show role {role}. slots: role: path.role - text: Get the details of role {role}. slots: role: path.role method: generated generated: '2026-09-26' - target: $.paths['/settings/roles/{role}'].put update: x-apievangelist-phrasing: intent: Update a role effect: write questions: - Can I rename a single role or change its parent? - Is it possible to edit one role's sharing settings? instructions: - text: Update role {role} with {roles}. slots: role: path.role roles: requestBody.roles - text: Rename role {role}. slots: role: path.role method: generated generated: '2026-09-26' - target: $.paths['/settings/roles/{role}'].delete update: x-apievangelist-phrasing: intent: Delete a role effect: destructive questions: - Can I delete a role that still has users in it? - Where do users go when their role is deleted? instructions: - text: Delete role {role} and move users to {transfer_to_id}. slots: role: path.role transfer_to_id: query.transfer_to_id - text: Remove role {role}, reassigning its users to role {transfer_to_id}. slots: role: path.role transfer_to_id: query.transfer_to_id method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules'].get update: x-apievangelist-phrasing: intent: List scoring rules effect: read questions: - Which lead scoring rules are configured? - Can I find scoring rules for a specific module or layout? instructions: - text: List all scoring rules. - text: List scoring rules for {module} on layout {layout_id}. slots: module: query.module layout_id: query.layout_id - text: Find the scoring rule named {name}. slots: name: query.name method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules'].put update: x-apievangelist-phrasing: intent: Update several scoring rules effect: write questions: - Can I update multiple scoring rules in one request? - Is there a bulk edit for scoring rule criteria? instructions: - text: Update scoring rules with {scoring_rules}. slots: scoring_rules: requestBody.scoring_rules - text: Bulk-change scoring rules per {scoring_rules}. slots: scoring_rules: requestBody.scoring_rules method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules'].post update: x-apievangelist-phrasing: intent: Create a scoring rule effect: write questions: - Can I set up a scoring rule that adds points for certain field values? - How do I configure a new scoring rule for a module and layout? instructions: - text: Create scoring rule {scoring_rules}. slots: scoring_rules: requestBody.scoring_rules - text: Add a new lead scoring rule defined as {scoring_rules}. slots: scoring_rules: requestBody.scoring_rules method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules'].delete update: x-apievangelist-phrasing: intent: Delete several scoring rules effect: destructive questions: - Can I delete multiple scoring rules at once? - Is there a bulk removal for scoring rules? instructions: - text: Delete scoring rules {ids}. slots: ids: query.ids - text: Remove the scoring rules with IDs {ids}. slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules/{ruleId}'].get update: x-apievangelist-phrasing: intent: Get a scoring rule effect: read questions: - What field and touch-point rules make up one scoring rule? - Can I fetch a single scoring rule by ID? instructions: - text: Show scoring rule {ruleId}. slots: ruleId: path.ruleId - text: Get the criteria of scoring rule {ruleId}. slots: ruleId: path.ruleId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules/{ruleId}'].put update: x-apievangelist-phrasing: intent: Update a scoring rule effect: write questions: - Can I change the field rules or touch-point rules of one scoring rule? - Is it possible to rename a single scoring rule? instructions: - text: Update scoring rule {ruleId} with {scoring_rules}. slots: ruleId: path.ruleId scoring_rules: requestBody.scoring_rules - text: Rename scoring rule {ruleId}. slots: ruleId: path.ruleId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules/{ruleId}'].delete update: x-apievangelist-phrasing: intent: Delete a scoring rule effect: destructive questions: - Can I delete one scoring rule I no longer use? - Is deleting a single scoring rule permanent? instructions: - text: Delete scoring rule {ruleId}. slots: ruleId: path.ruleId - text: Remove the scoring rule with ID {ruleId}. slots: ruleId: path.ruleId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules/{ruleId}/actions/activate'].put update: x-apievangelist-phrasing: intent: Activate a scoring rule effect: write questions: - Can I switch on a scoring rule that is inactive? - How do I start a scoring rule applying scores? instructions: - text: Activate scoring rule {ruleId}. slots: ruleId: path.ruleId - text: Turn on scoring rule {ruleId}. slots: ruleId: path.ruleId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules/{ruleId}/actions/activate'].delete update: x-apievangelist-phrasing: intent: Deactivate a scoring rule effect: destructive questions: - Can I pause a scoring rule without deleting it? - Is there a way to switch off one scoring rule temporarily? instructions: - text: Deactivate scoring rule {ruleId}. slots: ruleId: path.ruleId - text: Turn off scoring rule {ruleId} but keep it. slots: ruleId: path.ruleId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/scoring_rules/{ruleId}/actions/clone'].post update: x-apievangelist-phrasing: intent: Clone a scoring rule effect: write questions: - Can I copy an existing scoring rule as a starting point? - Is it possible to duplicate a scoring rule? instructions: - text: Clone scoring rule {ruleId}. slots: ruleId: path.ruleId - text: Make a copy of scoring rule {ruleId}. slots: ruleId: path.ruleId method: generated generated: '2026-09-26' - target: $.paths['/settings/service_preferences'].get update: x-apievangelist-phrasing: intent: Get service preferences effect: read questions: - What service preference settings does the organization use? - Where can I check our org's service configuration? instructions: - text: Show our service preferences. - text: Get the organization's service preference settings. method: generated generated: '2026-09-26' - target: $.paths['/settings/service_preferences'].put update: x-apievangelist-phrasing: intent: Update service preferences effect: write questions: - Can I change the organization's service preference settings? - Is it possible to update service configuration via the API? instructions: - text: Update service preferences to {service_preferences}. slots: service_preferences: requestBody.service_preferences - text: Change our service settings per {service_preferences}. slots: service_preferences: requestBody.service_preferences method: generated generated: '2026-09-26' - target: $.paths['/settings/business_hours/shift_hours'].get update: x-apievangelist-phrasing: intent: List shift hours effect: read questions: - Which shifts are configured, and who works each one? - What break hours and holidays apply to each shift? instructions: - text: List all shift hours. - text: Show every shift with its users and holidays. method: generated generated: '2026-09-26' - target: $.paths['/settings/business_hours/shift_hours'].put update: x-apievangelist-phrasing: intent: Update several shifts effect: write questions: - Can I change the timing of multiple shifts at once? - Is there a bulk update for shift break hours? instructions: - text: Update shift hours with {shift_hours}. slots: shift_hours: requestBody.shift_hours - text: Bulk-change shift timings per {shift_hours}. slots: shift_hours: requestBody.shift_hours method: generated generated: '2026-09-26' - target: $.paths['/settings/business_hours/shift_hours'].post update: x-apievangelist-phrasing: intent: Create shifts effect: write questions: - Can I add a night shift with its own hours and timezone? - How do I create new shift hour configurations? instructions: - text: Create shifts {shift_hours}. slots: shift_hours: requestBody.shift_hours - text: Add new shift hours defined as {shift_hours}. slots: shift_hours: requestBody.shift_hours method: generated generated: '2026-09-26' - target: $.paths['/settings/business_hours/shift_hours/{shift}'].get update: x-apievangelist-phrasing: intent: Get a shift effect: read questions: - What are the hours and breaks for one specific shift? - Which users are assigned to a given shift? instructions: - text: Show shift {shift}. slots: shift: path.shift - text: Get the timing and users of shift {shift}. slots: shift: path.shift method: generated generated: '2026-09-26' - target: $.paths['/settings/business_hours/shift_hours/{shift}'].put update: x-apievangelist-phrasing: intent: Update a shift effect: write questions: - Can I change the hours of one particular shift? - Is it possible to update a single shift's timezone? instructions: - text: Update shift {shift} with {shift_hours}. slots: shift: path.shift shift_hours: requestBody.shift_hours - text: Change the break hours of shift {shift}. slots: shift: path.shift method: generated generated: '2026-09-26' - target: $.paths['/settings/business_hours/shift_hours/{shift}'].delete update: x-apievangelist-phrasing: intent: Delete a shift effect: destructive questions: - Can I delete a shift I no longer use? - Is removing a shift configuration permanent? instructions: - text: Delete shift {shift}. slots: shift: path.shift - text: Remove the shift hours with ID {shift}. slots: shift: path.shift method: generated generated: '2026-09-26' - target: $.paths['/settings/tags/{id}/actions/records_count'].get update: x-apievangelist-phrasing: intent: Count records with a tag effect: read questions: - How many records carry a particular tag? - Can I count tagged records within one module? instructions: - text: Count records tagged {id} in {module}. slots: id: path.id module: query.module - text: Tell me how many {module} records use tag {id}. slots: module: query.module id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/tags/{id}/actions/merge'].post update: x-apievangelist-phrasing: intent: Merge two tags effect: destructive questions: - Can I merge a duplicate tag into another one? - What happens to records when two tags are merged? instructions: - text: Merge tag {id} with {tags}. slots: id: path.id tags: requestBody.tags - text: Combine tag {id} into the tag in {tags}. slots: id: path.id tags: requestBody.tags method: generated generated: '2026-09-26' - target: $.paths['/settings/tags'].get update: x-apievangelist-phrasing: intent: List tags in a module effect: read questions: - What tags are used in the Leads module? - Can I see which tags exist for a module and who created them? instructions: - text: List tags in {module}. slots: module: query.module - text: Show tags for {module} including {include}. slots: module: query.module include: query.include method: generated generated: '2026-09-26' - target: $.paths['/settings/tags'].put update: x-apievangelist-phrasing: intent: Update tags (IDs in body) effect: write questions: - Can I rename several tags at once by putting their IDs in the body? - Is there a bulk tag update for a module? instructions: - text: Update tags in {module} with {tags}. slots: module: query.module tags: requestBody.tags - text: Bulk-rename {module} tags per {tags}. slots: module: query.module tags: requestBody.tags method: generated generated: '2026-09-26' - target: $.paths['/settings/tags'].post update: x-apievangelist-phrasing: intent: Create tags effect: write questions: - Can I create new tags for a module before applying them to records? - How do I add several tags to a module? instructions: - text: Create tags {tags} in {module}. slots: tags: requestBody.tags module: query.module - text: Add new tags to the {module} module. slots: module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/tags/{id}'].put update: x-apievangelist-phrasing: intent: Update one tag effect: write questions: - Can I rename or recolor one specific tag? - Is it possible to edit a single tag by ID? instructions: - text: Update tag {id} with {tags}. slots: id: path.id tags: requestBody.tags - text: Rename the tag with ID {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/tags/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a tag effect: destructive questions: - Can I delete a single tag I no longer use? - Does deleting a tag remove it from tagged records? instructions: - text: Delete tag {id}. slots: id: path.id - text: Remove the tag with ID {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/territories'].get update: x-apievangelist-phrasing: intent: List territories effect: read questions: - What sales territories are defined in my CRM? - Can I filter and page through territories? instructions: - text: List all territories. - text: List territories {ids}. slots: ids: query.ids - text: List territories matching {filters}, page {page}. slots: filters: query.filters page: query.page method: generated generated: '2026-09-26' - target: $.paths['/settings/territories'].put update: x-apievangelist-phrasing: intent: Update several territories effect: write questions: - Can I update multiple territories in one request? - Is there a bulk edit for territory managers or criteria? instructions: - text: Update territories with {territories}. slots: territories: requestBody.territories - text: Bulk-change territory settings per {territories}. slots: territories: requestBody.territories method: generated generated: '2026-09-26' - target: $.paths['/settings/territories'].post update: x-apievangelist-phrasing: intent: Create territories effect: write questions: - Can I set up new sales territories under a parent territory? - How do I create territories with assignment criteria? instructions: - text: Create territories {territories}. slots: territories: requestBody.territories - text: Add new territories defined as {territories}. slots: territories: requestBody.territories method: generated generated: '2026-09-26' - target: $.paths['/settings/territories'].delete update: x-apievangelist-phrasing: intent: Delete several territories effect: destructive questions: - Can I delete multiple territories at once? - Is it possible to delete past forecasts along with the territories? instructions: - text: Delete territories {ids}. slots: ids: query.ids - text: 'Delete territories {ids} and their previous forecasts: {delete_previous_forecasts}.' slots: ids: query.ids delete_previous_forecasts: query.delete_previous_forecasts method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{id}'].get update: x-apievangelist-phrasing: intent: Get a territory effect: read questions: - Who manages a specific territory and what are its criteria? - Can I fetch one territory by ID? instructions: - text: Show territory {id}. slots: id: path.id - text: Get territory {id} with inner details. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{id}'].put update: x-apievangelist-phrasing: intent: Update one territory effect: write questions: - Can I change the manager of one territory? - Is it possible to edit a single territory's criteria by ID? instructions: - text: Update territory {id} with {territories}. slots: id: path.id territories: requestBody.territories - text: Change the manager of territory {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{id}'].delete update: x-apievangelist-phrasing: intent: Delete one territory effect: destructive questions: - Can I delete one territory and its old forecasts? - What happens to forecasts when a single territory is deleted? instructions: - text: Delete territory {id}. slots: id: path.id - text: Delete territory {id} with previous forecasts set to {delete_previous_forecasts}. slots: id: path.id delete_previous_forecasts: query.delete_previous_forecasts method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/actions/transfer_and_delete'].post update: x-apievangelist-phrasing: intent: Transfer and delete territories effect: destructive questions: - Can I move records to another territory before deleting several territories? - Is there a bulk transfer-and-delete for territories? instructions: - text: Transfer and delete territories per {territories}. slots: territories: requestBody.territories - text: Move records out of and remove the territories in {territories}. slots: territories: requestBody.territories method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{id}/actions/transfer_and_delete'].post update: x-apievangelist-phrasing: intent: Transfer and delete one territory effect: destructive questions: - Can I hand one territory's records to another territory and then delete it? - How do I retire a single territory without losing its records? instructions: - text: Transfer and delete territory {id} per {territories}. slots: id: path.id territories: requestBody.territories - text: Retire territory {id}, moving its records to another territory. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{id}/__child_territories'].get update: x-apievangelist-phrasing: intent: List child territories effect: read questions: - Which territories sit beneath a given parent territory? - Can I see the sub-territories of one territory? instructions: - text: List child territories of {id}. slots: id: path.id - text: Show sub-territories under {id} matching {filters}. slots: id: path.id filters: query.filters method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/actions/associated_users_count'].get update: x-apievangelist-phrasing: intent: Count users per territory effect: read questions: - How many users are assigned to each territory? - Can I get territory membership counts in one call? instructions: - text: Count users associated with each territory. - text: Show the number of users in every territory. method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{territory}/users'].get update: x-apievangelist-phrasing: intent: List users in a territory effect: read questions: - Which users belong to a specific territory? - Who is assigned to the West Coast territory? instructions: - text: List users in territory {territory}. slots: territory: path.territory - text: Show members of territory {territory}. slots: territory: path.territory method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{territory}/users'].put update: x-apievangelist-phrasing: intent: Add users to a territory effect: write questions: - Can I add several users to a territory at once? - How do I assign reps to a territory? instructions: - text: Add users {users} to territory {territory}. slots: users: requestBody.users territory: path.territory - text: 'Assign these reps to territory {territory}: {users}.' slots: territory: path.territory users: requestBody.users method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{territory}/users'].delete update: x-apievangelist-phrasing: intent: Remove users from a territory effect: destructive questions: - Can I remove several users from a territory in one call? - Is there a bulk way to unassign reps from a territory? instructions: - text: Remove users {ids} from territory {territory}. slots: ids: query.ids territory: path.territory - text: Unassign users {ids} from territory {territory}. slots: ids: query.ids territory: path.territory method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{territory}/users/{user}'].get update: x-apievangelist-phrasing: intent: Get a user in a territory effect: read questions: - Is a particular user part of a given territory? - Can I see one user's membership details in a territory? instructions: - text: Show user {user} in territory {territory}. slots: user: path.user territory: path.territory - text: Check whether user {user} belongs to territory {territory}. slots: user: path.user territory: path.territory method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{territory}/users/{user}'].put update: x-apievangelist-phrasing: intent: Add one user to a territory effect: write questions: - Can I add a single rep to a territory? - How do I put one specific user into a territory? instructions: - text: Add user {user} to territory {territory}. slots: user: path.user territory: path.territory - text: Assign rep {user} to territory {territory}. slots: user: path.user territory: path.territory method: generated generated: '2026-09-26' - target: $.paths['/settings/territories/{territory}/users/{user}'].delete update: x-apievangelist-phrasing: intent: Remove one user from a territory effect: destructive questions: - Can I take one specific user out of a territory? - What happens when a single rep is removed from a territory? instructions: - text: Remove user {user} from territory {territory}. slots: user: path.user territory: path.territory - text: Unassign rep {user} from territory {territory}. slots: user: path.user territory: path.territory method: generated generated: '2026-09-26' - target: $.paths['/settings/unsubscribe_links'].get update: x-apievangelist-phrasing: intent: List unsubscribe links effect: read questions: - What unsubscribe links are configured for our emails? - Which opt-out pages do we have set up? instructions: - text: List all unsubscribe links. - text: Show our email opt-out links. method: generated generated: '2026-09-26' - target: $.paths['/settings/unsubscribe_links'].put update: x-apievangelist-phrasing: intent: Update unsubscribe links (ID in body) effect: write questions: - Can I update an unsubscribe link by passing its ID in the request body? - Is there a bulk edit for unsubscribe link pages? instructions: - text: Update unsubscribe links with {unsubscribe_links}. slots: unsubscribe_links: requestBody.unsubscribe_links - text: Change opt-out link settings in bulk per {unsubscribe_links}. slots: unsubscribe_links: requestBody.unsubscribe_links method: generated generated: '2026-09-26' - target: $.paths['/settings/unsubscribe_links'].post update: x-apievangelist-phrasing: intent: Create an unsubscribe link effect: write questions: - Can I create a custom unsubscribe page for email recipients? - How do I add a new opt-out link? instructions: - text: Create unsubscribe link {unsubscribe_links}. slots: unsubscribe_links: requestBody.unsubscribe_links - text: Add a new opt-out link defined as {unsubscribe_links}. slots: unsubscribe_links: requestBody.unsubscribe_links method: generated generated: '2026-09-26' - target: $.paths['/settings/unsubscribe_links/{id}'].get update: x-apievangelist-phrasing: intent: Get an unsubscribe link effect: read questions: - What page does a specific unsubscribe link point to? - Can I fetch one unsubscribe link by ID? instructions: - text: Show unsubscribe link {id}. slots: id: path.id - text: Get the details of opt-out link {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/unsubscribe_links/{id}'].put update: x-apievangelist-phrasing: intent: Update one unsubscribe link effect: write questions: - Can I edit a single unsubscribe link using its ID in the URL? - Is it possible to change the landing page of one opt-out link? instructions: - text: Update unsubscribe link {id} with {unsubscribe_links}. slots: id: path.id unsubscribe_links: requestBody.unsubscribe_links - text: Change the landing page of opt-out link {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/unsubscribe_links/{id}'].delete update: x-apievangelist-phrasing: intent: Delete an unsubscribe link effect: destructive questions: - Can I delete an unsubscribe link I no longer use? - Is removing an opt-out link permanent? instructions: - text: Delete unsubscribe link {id}. slots: id: path.id - text: Remove opt-out link {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/unsubscribe_link/actions/associations'].get update: x-apievangelist-phrasing: intent: See where unsubscribe links are used effect: read questions: - Which email templates or campaigns use our unsubscribe links? - Is an unsubscribe link safe to delete, or is it still associated somewhere? instructions: - text: Show where unsubscribe links are associated. - text: List the usages of our opt-out links. method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups'].get update: x-apievangelist-phrasing: intent: List user groups effect: read questions: - What user groups exist in my organization? - Can I filter and page through user groups? instructions: - text: List all user groups. - text: List user groups matching {filters}. slots: filters: query.filters method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups'].post update: x-apievangelist-phrasing: intent: Create a user group effect: write questions: - Can I create a group of users for sharing rules or workflows? - How do I add a new user group with its members? instructions: - text: Create user group {user_groups}. slots: user_groups: requestBody.user_groups - text: Add a new user group defined as {user_groups}. slots: user_groups: requestBody.user_groups method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups/{group}'].get update: x-apievangelist-phrasing: intent: Get a user group effect: read questions: - What is the description and setup of one user group? - Can I fetch a single user group by ID? instructions: - text: Show user group {group}. slots: group: path.group - text: Get the details of user group {group}. slots: group: path.group method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups/{group}'].put update: x-apievangelist-phrasing: intent: Update a user group effect: write questions: - Can I rename a user group or change its members? - Is it possible to edit an existing user group? instructions: - text: Update user group {group} with {user_groups}. slots: group: path.group user_groups: requestBody.user_groups - text: Rename user group {group}. slots: group: path.group method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups/{group}'].delete update: x-apievangelist-phrasing: intent: Delete a user group effect: destructive questions: - Can I delete a user group that's no longer needed? - Is deleting a user group permanent? instructions: - text: Delete user group {group}. slots: group: path.group - text: Remove the user group with ID {group}. slots: group: path.group method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups/{group}/sources'].get update: x-apievangelist-phrasing: intent: List a user group's members effect: read questions: - Which users, roles and territories make up a user group? - Can I page through the members of one group? instructions: - text: List members of user group {group}. slots: group: path.group - text: Show sources in group {group}, page {page}. slots: group: path.group page: query.page method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups/{group}/actions/sources_count'].get update: x-apievangelist-phrasing: intent: Count a user group's sources effect: read questions: - How many territories, roles, groups and users are in a user group? - Can I get a member breakdown count for one group? instructions: - text: Count the sources in user group {group}. slots: group: path.group - text: Give me the member counts by type for group {group}. slots: group: path.group method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups/actions/associated_users_count'].get update: x-apievangelist-phrasing: intent: Count users across user groups effect: read questions: - How many users belong to each user group? - Can I filter the user counts across groups? instructions: - text: Count users associated with user groups. - text: Count users in user groups matching {filters}. slots: filters: query.filters method: generated generated: '2026-09-26' - target: $.paths['/settings/user_groups/{group}/actions/associations'].get update: x-apievangelist-phrasing: intent: See where a user group is used effect: read questions: - Which sharing rules or workflows reference a specific user group? - Is a user group used in approvals or assignment rules? instructions: - text: Show associations of user group {group}. slots: group: path.group - text: List the rules and processes that use group {group}. slots: group: path.group method: generated generated: '2026-09-26' - target: $.paths['/settings/variable_groups'].get update: x-apievangelist-phrasing: intent: List variable groups effect: read questions: - What variable groups have been created in the org? - Which groups organize our CRM variables? instructions: - text: List all variable groups. - text: Show our CRM variable groups. method: generated generated: '2026-09-26' - target: $.paths['/settings/variable_groups'].put update: x-apievangelist-phrasing: intent: Update variable groups (IDs in body) effect: write questions: - Can I update several variable groups in one request? - Is there a bulk rename for variable groups? instructions: - text: Update variable groups with {variable_groups}. slots: variable_groups: requestBody.variable_groups - text: Bulk-edit variable group details per {variable_groups}. slots: variable_groups: requestBody.variable_groups method: generated generated: '2026-09-26' - target: $.paths['/settings/variable_groups/{id}'].get update: x-apievangelist-phrasing: intent: Get a variable group effect: read questions: - What are the details of one variable group? - Can I fetch a single variable group by ID? instructions: - text: Show variable group {id}. slots: id: path.id - text: Get the details of variable group {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/variable_groups/{id}'].put update: x-apievangelist-phrasing: intent: Update one variable group effect: write questions: - Can I rename one variable group by ID? - Is it possible to change a single variable group's description? instructions: - text: Update variable group {id} with {variable_groups}. slots: id: path.id variable_groups: requestBody.variable_groups - text: Rename variable group {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/variables'].get update: x-apievangelist-phrasing: intent: List variables effect: read questions: - What org variables are defined for use in functions and templates? - Which CRM variables exist and what are their values? instructions: - text: List all variables. - text: Show every org variable and its value. method: generated generated: '2026-09-26' - target: $.paths['/settings/variables'].put update: x-apievangelist-phrasing: intent: Update several variables effect: write questions: - Can I update multiple variable values at once? - Is there a bulk edit for org variables? instructions: - text: Update variables with {variables}. slots: variables: requestBody.variables - text: Bulk-change variable values per {variables}. slots: variables: requestBody.variables method: generated generated: '2026-09-26' - target: $.paths['/settings/variables'].post update: x-apievangelist-phrasing: intent: Create variables effect: write questions: - Can I create a new org variable for an API key or constant? - How do I add variables to a variable group? instructions: - text: Create variables {variables}. slots: variables: requestBody.variables - text: Add new org variables defined as {variables}. slots: variables: requestBody.variables method: generated generated: '2026-09-26' - target: $.paths['/settings/variables'].delete update: x-apievangelist-phrasing: intent: Delete several variables effect: destructive questions: - Can I delete multiple variables at once? - Is there a bulk removal for org variables? instructions: - text: Delete variables {ids}. slots: ids: query.ids - text: Remove the variables with IDs {ids}. slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/settings/variables/{id}'].get update: x-apievangelist-phrasing: intent: Get a variable effect: read questions: - What is the current value of one specific variable? - Can I look up a variable by ID within its group? instructions: - text: Show variable {id}. slots: id: path.id - text: Get variable {id} in group {group}. slots: id: path.id group: query.group method: generated generated: '2026-09-26' - target: $.paths['/settings/variables/{id}'].put update: x-apievangelist-phrasing: intent: Update a variable effect: write questions: - Can I change the value of one variable? - Is it possible to update a single org variable by ID? instructions: - text: Update variable {id} with {variables}. slots: id: path.id variables: requestBody.variables - text: Change the value of variable {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/variables/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a variable effect: destructive questions: - Can I delete one variable I no longer need? - What breaks if a single org variable is removed? instructions: - text: Delete variable {id}. slots: id: path.id - text: Remove the variable with ID {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks'].get update: x-apievangelist-phrasing: intent: List webhooks effect: read questions: - Which webhooks are configured in my CRM? - Can I list webhooks for one module sorted by name? instructions: - text: List all webhooks. - text: List webhooks for {module}. slots: module: query.module - text: List webhooks 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/webhooks'].put update: x-apievangelist-phrasing: intent: Update webhooks (IDs in body) effect: write questions: - Can I update several webhooks in one call with their IDs in the body? - Is there a bulk edit for webhook URLs? instructions: - text: Update webhooks with {webhooks}. slots: webhooks: requestBody.webhooks - text: Bulk-change webhook settings per {webhooks}. slots: webhooks: requestBody.webhooks method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks'].post update: x-apievangelist-phrasing: intent: Create a webhook effect: write questions: - Can I send CRM data to an external service when a record changes? - How do I set up a new webhook to post to my URL? instructions: - text: Create webhook {webhooks}. slots: webhooks: requestBody.webhooks - text: Add a webhook that posts to my service, defined as {webhooks}. slots: webhooks: requestBody.webhooks method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks'].delete update: x-apievangelist-phrasing: intent: Delete several webhooks effect: destructive questions: - Can I delete multiple webhooks at once? - What's the maximum number of webhooks I can delete per call? instructions: - text: Delete webhooks {ids}. slots: ids: query.ids - text: 'Remove up to ten webhooks: {ids}.' slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks/{webhookId}'].get update: x-apievangelist-phrasing: intent: Get a webhook effect: read questions: - What URL and payload does one webhook send? - Can I fetch a single webhook's configuration by ID? instructions: - text: Show webhook {webhookId}. slots: webhookId: path.webhookId - text: Get the configuration of webhook {webhookId}. slots: webhookId: path.webhookId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks/{webhookId}'].put update: x-apievangelist-phrasing: intent: Update one webhook effect: write questions: - Can I change the URL of one specific webhook? - Is it possible to edit a single webhook's parameters by ID? instructions: - text: Update webhook {webhookId} with {webhooks}. slots: webhookId: path.webhookId webhooks: requestBody.webhooks - text: Change the target URL of webhook {webhookId}. slots: webhookId: path.webhookId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks/{webhookId}'].delete update: x-apievangelist-phrasing: intent: Delete a webhook effect: destructive questions: - Can I delete one webhook I no longer need? - Is deleting a single webhook permanent? instructions: - text: Delete webhook {webhookId}. slots: webhookId: path.webhookId - text: Remove the webhook with ID {webhookId}. slots: webhookId: path.webhookId method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhook_failures'].get update: x-apievangelist-phrasing: intent: List webhook failures effect: read questions: - Why are my webhooks failing, and when did they fail? - Can I see failures for one webhook within a date range? instructions: - text: List webhook failures. - text: Show failures for webhook {webhook_id} from {from} to {to}. slots: webhook_id: query.webhook_id from: query.from to: query.to method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks/actions/associated_modules'].get update: x-apievangelist-phrasing: intent: List modules using webhooks effect: read questions: - Which modules have webhook actions associated with them? - What modules currently fire webhooks? instructions: - text: List modules associated with webhooks. - text: Show which modules use webhook actions. method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/webhooks/actions/usage_reports'].get update: x-apievangelist-phrasing: intent: Get webhook usage report effect: read questions: - How many webhook calls ran over the last seven days? - Can I break down webhook usage by module or date? instructions: - text: Show webhook usage grouped by {group_by}. slots: group_by: query.group_by - text: Get webhook usage grouped by {group_by} from {from} to {to}. slots: group_by: query.group_by from: query.from to: query.to method: generated generated: '2026-09-26' - target: $.paths['/settings/wizards'].get update: x-apievangelist-phrasing: intent: List wizards effect: read questions: - What wizards are set up for guided record creation? - Can I list only the wizards for one module? instructions: - text: List all wizards. - text: List wizards for {module}. slots: module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules'].get update: x-apievangelist-phrasing: intent: List workflow rules effect: read questions: - Which workflow rules are active in a module? - Can I filter workflow rules by when they execute? instructions: - text: List all workflow rules. - text: List workflow rules in {module} that run on {execute_on}. slots: module: query.module execute_on: query.execute_on - text: List workflow rules with active status {status_active}. slots: status_active: query.status_active method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules'].put update: x-apievangelist-phrasing: intent: Update workflow rules (ID in body) effect: write questions: - Can I update a workflow rule by passing its ID in the request body? - Is there a bulk partial update for workflow rules? instructions: - text: Update workflow rules with {workflow_rules}. slots: workflow_rules: requestBody.workflow_rules - text: Patch several workflows at once using {workflow_rules}. slots: workflow_rules: requestBody.workflow_rules method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules'].post update: x-apievangelist-phrasing: intent: Create a workflow rule effect: write questions: - Can I set up a workflow that sends an email when a deal is won? - How do I configure a new workflow rule with actions? instructions: - text: Create workflow rule {workflow_rules}. slots: workflow_rules: requestBody.workflow_rules - text: Configure a new workflow defined as {workflow_rules}. slots: workflow_rules: requestBody.workflow_rules method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules'].delete update: x-apievangelist-phrasing: intent: Delete several workflow rules effect: destructive questions: - Can I delete multiple workflow rules at once? - Is there a bulk removal for workflows? instructions: - text: Delete workflow rules {ids}. slots: ids: query.ids - text: Remove the workflows with IDs {ids}. slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/{id}'].get update: x-apievangelist-phrasing: intent: Get a workflow rule effect: read questions: - What criteria and actions does one workflow rule have? - Can I fetch a single workflow by ID? instructions: - text: Show workflow rule {id}. slots: id: path.id - text: Get the actions of workflow {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/{id}'].put update: x-apievangelist-phrasing: intent: Update one workflow rule effect: write questions: - Can I change the criteria of one workflow using its ID in the URL? - Is it possible to deactivate a single workflow rule? instructions: - text: Update workflow rule {id} with {workflow_rules}. slots: id: path.id workflow_rules: requestBody.workflow_rules - text: Deactivate workflow {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a workflow rule effect: destructive questions: - Can I delete one workflow rule I no longer use? - Is deleting a single workflow permanent? instructions: - text: Delete workflow rule {id}. slots: id: path.id - text: Remove the workflow with ID {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/actions/actions_count'].get update: x-apievangelist-phrasing: intent: Count actions in workflow rules effect: read questions: - How many instant and scheduled actions do my workflows have? - Can I count actions for a specific set of workflow rules? instructions: - text: Count actions in workflow rules {ids}. slots: ids: query.ids - text: Show instant and scheduled action totals for workflows {ids}. slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/actions/module_specific_count'].get update: x-apievangelist-phrasing: intent: Count workflow actions per module effect: read questions: - How many workflow actions does each module have? - Which module has the most workflow actions configured? instructions: - text: Count workflow actions for each module. - text: Count workflow actions in {module}. slots: module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/actions/rules_count'].get update: x-apievangelist-phrasing: intent: Get workflow rule limits and usage effect: read questions: - How close am I to my workflow rule limit? - What is the allowed number of workflow rules and actions on my plan? instructions: - text: Show my workflow rule limits and usage. - text: Check how many workflow rules I've used versus my limit. method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/{workflowRuleId}/actions/usage'].get update: x-apievangelist-phrasing: intent: Get a workflow rule's execution usage effect: read questions: - How many times did a particular workflow run last month? - Can I see a usage report for one workflow over a date range? instructions: - text: Show usage of workflow {workflowRuleId} from {executed_from} to {executed_till}. slots: workflowRuleId: path.workflowRuleId executed_from: query.executed_from executed_till: query.executed_till - text: Count executions of workflow {workflowRuleId} between {executed_from} and {executed_till}. slots: workflowRuleId: path.workflowRuleId executed_from: query.executed_from executed_till: query.executed_till method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/workflow_rules/actions/reorder'].put update: x-apievangelist-phrasing: intent: Reorder workflow rules effect: write questions: - Can I change the order in which workflow rules run? - Why do workflows execute in creation order, and can I override it? instructions: - text: Reorder workflow rules as {reorder}. slots: reorder: requestBody.reorder - text: Set the execution order of {module} workflows to {reorder}. slots: module: query.module reorder: requestBody.reorder method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/tasks'].get update: x-apievangelist-phrasing: intent: List automation tasks effect: read questions: - Which automation task actions are configured for workflows? - Can I list automation tasks for one module? instructions: - text: List automation tasks. - text: List automation tasks for {module}. slots: module: query.module method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/tasks'].post update: x-apievangelist-phrasing: intent: Create an automation task effect: write questions: - Can I create a task action that workflows assign automatically? - How do I add a new automation task? instructions: - text: Create automation task {tasks}. slots: tasks: requestBody.tasks - text: Add a workflow task action defined as {tasks}. slots: tasks: requestBody.tasks method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/tasks'].delete update: x-apievangelist-phrasing: intent: Delete several automation tasks effect: destructive questions: - Can I delete multiple automation tasks at once? - Is there a bulk removal for workflow task actions? instructions: - text: Delete automation tasks {ids}. slots: ids: query.ids - text: Remove the automation tasks with IDs {ids}. slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/tasks/{id}'].get update: x-apievangelist-phrasing: intent: Get an automation task effect: read questions: - What subject and due date does one automation task set? - Can I fetch a single automation task by ID? instructions: - text: Show automation task {id}. slots: id: path.id - text: Get automation task {id} with inner details. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/tasks/{id}'].put update: x-apievangelist-phrasing: intent: Update an automation task effect: write questions: - Can I change the subject or due date of one automation task? - Is it possible to edit a single workflow task action? instructions: - text: Update automation task {id} with {tasks}. slots: id: path.id tasks: requestBody.tasks - text: Change the due date of automation task {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/automation/tasks/{id}'].delete update: x-apievangelist-phrasing: intent: Delete an automation task effect: destructive questions: - Can I delete one automation task I no longer use? - Is deleting a single automation task permanent? instructions: - text: Delete automation task {id}. slots: id: path.id - text: Remove the automation task with ID {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/settings/zia/data_enrichment'].get update: x-apievangelist-phrasing: intent: Get Zia data enrichment settings effect: read questions: - Is Zia data enrichment configured for our modules? - Which fields does Zia enrichment fill in? instructions: - text: Show the Zia data enrichment configuration. - text: Get our Zia enrichment settings. method: generated generated: '2026-09-26'