# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Live Direct Marketing Online Settings API version: 1.0.0 extends: openapi/live-direct-marketing-online-settings-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-10-01' generator: build-phrasing.py label: Generated by API Evangelist operations: 55 - target: $.paths['/api/settings'].get update: x-apievangelist-phrasing: intent: Get the full workspace settings document effect: read questions: - Where can I see every setting for my workspace in one response? - What does the complete workspace settings document contain? instructions: - text: Fetch the entire settings document for my workspace. - text: Show me all of our workspace settings at once. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/ai-providers'].patch update: x-apievangelist-phrasing: intent: Update AI provider keys and defaults effect: write questions: - How do I change which AI provider my workspace uses by default? - Can I set a fallback AI provider and a low-balance threshold? instructions: - text: Switch our AI provider to {aiProvider} with default model {defaultAiModel}. slots: aiProvider: requestBody.aiProvider defaultAiModel: requestBody.defaultAiModel - text: Set {fallbackProvider} as the fallback AI provider and alert below a balance of {balanceThreshold}. slots: fallbackProvider: requestBody.fallbackProvider balanceThreshold: requestBody.balanceThreshold method: generated generated: '2026-10-01' - target: $.paths['/api/settings/ldm-ai/request'].post update: x-apievangelist-phrasing: intent: Request LDM AI access or a balance increase effect: write questions: - How do I ask an admin to turn on LDM AI for my workspace? - Can I request more LDM AI balance from the platform admins? instructions: - text: Send an LDM AI access request to the admins with the note {note}. slots: note: requestBody.note - text: Ask the admins to raise our LDM AI balance. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/notifications'].patch update: x-apievangelist-phrasing: intent: Update push and email notification preferences effect: write questions: - How do I turn email notifications on or off for my account? - Can I change the address my notification emails go to? instructions: - text: Send my email notifications to {notifyEmail}. slots: notifyEmail: requestBody.notifyEmail - text: Turn push notifications {pushNotify} using push key {pushKey}. slots: pushNotify: requestBody.pushNotify pushKey: requestBody.pushKey method: generated generated: '2026-10-01' - target: $.paths['/api/settings/workspace'].patch update: x-apievangelist-phrasing: intent: Rename a workspace or change its currency and language effect: write questions: - How do I rename my workspace? - Can I change the default currency and language of the workspace? instructions: - text: Rename the workspace to {workspaceName}. slots: workspaceName: requestBody.workspaceName - text: Set the workspace default currency to {defaultCurrency} and language to {defaultLanguage}. slots: defaultCurrency: requestBody.defaultCurrency defaultLanguage: requestBody.defaultLanguage method: generated generated: '2026-10-01' - target: $.paths['/api/settings/profile'].get update: x-apievangelist-phrasing: intent: Get the current user's profile effect: read questions: - What name is on my user profile right now? - Where do I look up my own profile details? instructions: - text: Show me my user profile. - text: Fetch the profile of the user I am logged in as. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/profile'].patch update: x-apievangelist-phrasing: intent: Change the current user's name effect: write questions: - How do I change the first and last name on my profile? - Can I fix a typo in my surname? instructions: - text: Change my profile name to {firstName} {lastName}. slots: firstName: requestBody.firstName lastName: requestBody.lastName - text: Update my last name to {lastName}. slots: lastName: requestBody.lastName method: generated generated: '2026-10-01' - target: $.paths['/api/settings/ui-preferences'].get update: x-apievangelist-phrasing: intent: Get my dashboard and menu layout preferences effect: read questions: - Which dashboard blocks and left-menu items have I configured? - Where are my saved UI layout preferences stored? instructions: - text: Show my saved dashboard block and left menu preferences. - text: Fetch my UI preferences. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/ui-preferences'].patch update: x-apievangelist-phrasing: intent: Replace my dashboard and menu layout preferences effect: write questions: - How do I save a new dashboard block layout for myself? - Can I overwrite my left menu configuration in one go? instructions: - text: Replace my UI preferences with the new dashboard and menu layout. - text: Save this left menu arrangement as my UI preferences. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/profile/avatar'].post update: x-apievangelist-phrasing: intent: Upload a new profile avatar effect: write questions: - How do I upload a profile picture? - Can I replace my current avatar with a new image file? instructions: - text: Upload {file} as my new avatar. slots: file: requestBody.file - text: Set my profile picture to the image {file}. slots: file: requestBody.file method: generated generated: '2026-10-01' - target: $.paths['/api/settings/profile/avatar'].delete update: x-apievangelist-phrasing: intent: Remove my profile avatar effect: destructive questions: - How do I remove my profile picture? - Can I go back to having no avatar? instructions: - text: Delete my avatar. - text: Remove the profile picture from my account. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/security/change-password'].post update: x-apievangelist-phrasing: intent: Change my password effect: write questions: - How do I change my login password? - Do I need my current password to set a new one? instructions: - text: Change my password from {currentPassword} to {newPassword}. slots: currentPassword: requestBody.currentPassword newPassword: requestBody.newPassword - text: Replace my login password with {newPassword}; my current one is {currentPassword}. slots: newPassword: requestBody.newPassword currentPassword: requestBody.currentPassword method: generated generated: '2026-10-01' - target: $.paths['/api/settings/security/sessions'].get update: x-apievangelist-phrasing: intent: List my active login sessions effect: read questions: - Which devices am I currently logged in on? - How can I see all my active sessions? instructions: - text: List my active sessions. - text: Show every place my account is logged in right now. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/security/sessions'].delete update: x-apievangelist-phrasing: intent: Log out of all sessions effect: destructive questions: - How do I sign out of every device at once? - Can I kill all of my active sessions if my account was compromised? instructions: - text: Revoke all of my active sessions. - text: Log me out everywhere. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/security/sessions/{sessionId}'].delete update: x-apievangelist-phrasing: intent: Log out one specific session effect: destructive questions: - How do I sign out just one device I don't recognize? - Can I end a single session without logging out everywhere? instructions: - text: Revoke session {sessionId}. slots: sessionId: path.sessionId - text: Log out the single session {sessionId} and keep the others. slots: sessionId: path.sessionId method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/bo-nalog'].get update: x-apievangelist-phrasing: intent: Check the bo.nalog.gov.ru integration state effect: read questions: - Is the bo.nalog.gov.ru financial reports integration enabled? - How many bo.nalog requests have we made today and what was the last error? instructions: - text: Show the bo.nalog.gov.ru integration status and today's request count. - text: Check the last error from the bo.nalog integration. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/bo-nalog'].patch update: x-apievangelist-phrasing: intent: Enable or throttle the bo.nalog.gov.ru integration effect: write questions: - How do I turn off the bo.nalog.gov.ru integration? - Can I cap bo.nalog requests per minute? instructions: - text: Enable the bo.nalog.gov.ru integration. - text: Lower the bo.nalog requests-per-minute cap. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/dadata'].get update: x-apievangelist-phrasing: intent: Get the DaData integration configuration effect: read questions: - How is the DaData integration configured for my workspace? - Is DaData enrichment turned on? instructions: - text: Show the DaData integration settings. - text: Fetch our DaData configuration. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/dadata'].patch update: x-apievangelist-phrasing: intent: Update the DaData integration configuration effect: write questions: - How do I change the DaData integration settings? - Can I turn DaData enrichment off for the workspace? instructions: - text: Update the DaData integration configuration. - text: Disable the DaData integration. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/dadata/reset-counter'].post update: x-apievangelist-phrasing: intent: Reset the DaData daily request counter effect: write questions: - How do I reset the DaData daily request counter? - Can I zero out today's DaData usage count? instructions: - text: Reset the DaData daily counter. - text: Zero today's DaData request count. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/inbox-check'].get update: x-apievangelist-phrasing: intent: Get the Inbox Check integration configuration effect: read questions: - How is Inbox Check set up in my workspace? - Which Inbox Check settings are currently saved? instructions: - text: Show the Inbox Check integration settings. - text: Fetch our Inbox Check configuration. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/inbox-check'].patch update: x-apievangelist-phrasing: intent: Update the Inbox Check integration configuration effect: write questions: - How do I change the Inbox Check integration settings? - Can I switch Inbox Check off? instructions: - text: Update the Inbox Check integration configuration. - text: Disable the Inbox Check integration. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/inbox-check/test'].post update: x-apievangelist-phrasing: intent: Test the Inbox Check connection effect: write questions: - Is my Inbox Check connection actually working? - How do I verify the Inbox Check credentials I saved? instructions: - text: Test the Inbox Check connection. - text: Run a connectivity check against Inbox Check. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/smartlead'].get update: x-apievangelist-phrasing: intent: Get the Smartlead integration configuration effect: read questions: - How is the Smartlead integration configured? - Is Smartlead connected to my workspace? instructions: - text: Show the Smartlead integration settings. - text: Fetch our Smartlead configuration. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/smartlead'].patch update: x-apievangelist-phrasing: intent: Update the Smartlead integration configuration effect: write questions: - How do I change the Smartlead integration settings? - Can I disconnect Smartlead from the workspace? instructions: - text: Update the Smartlead integration configuration. - text: Disable the Smartlead integration. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/smartlead/test'].post update: x-apievangelist-phrasing: intent: Test the Smartlead connection effect: write questions: - Is my Smartlead connection working? - How do I confirm the Smartlead credentials are valid? instructions: - text: Test the Smartlead connection. - text: Run a connectivity check against Smartlead. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/smartlead/placement-matrix'].get update: x-apievangelist-phrasing: intent: View the Smartlead inbox placement matrix effect: read questions: - Which of my mailboxes land in the inbox for each mail provider according to Smartlead? - Where can I see Smartlead placement results across all mailboxes and providers? instructions: - text: Show the Smartlead placement matrix of mailboxes by provider. - text: Give me the full Smartlead inbox placement grid. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/integrations/smartlead/placement-history'].get update: x-apievangelist-phrasing: intent: View Smartlead placement history for one mailbox effect: read questions: - How has inbox placement changed over time for one mailbox at one provider? - Can I drill into the Smartlead history of a single placement cell? instructions: - text: Show Smartlead placement history for mailbox {mailbox} at provider {provider}. slots: mailbox: query.mailbox provider: query.provider - text: Trace how {mailbox} has placed at {provider} over time in Smartlead. slots: mailbox: query.mailbox provider: query.provider method: generated generated: '2026-10-01' - target: $.paths['/api/settings/transports'].get update: x-apievangelist-phrasing: intent: See which mail transports are enabled effect: read questions: - Which mail transports are switched on for my workspace? - What are the current mail transport flags? instructions: - text: Show the enabled mail transport flags. - text: List which sending transports are on. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/transports'].patch update: x-apievangelist-phrasing: intent: Turn mail transports on or off effect: write questions: - How do I disable a mail transport we no longer use? - Can I enable an additional sending transport? instructions: - text: Update the enabled mail transport flags. - text: Turn off the relay transport. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/mailing-auto-approve'].get update: x-apievangelist-phrasing: intent: List users with mailing auto-approve enabled effect: read questions: - Which users can send mailings without manual approval? - Who has per-user mailing auto-approve turned on in a given user's tenant? instructions: - text: List users with mailing auto-approve in the tenant of user {userId}. slots: userId: query.userId - text: Show who can send without approval in user {userId}'s workspace. slots: userId: query.userId method: generated generated: '2026-10-01' - target: $.paths['/api/settings/users/{userId}/mailing-auto-approve'].patch update: x-apievangelist-phrasing: intent: Turn mailing auto-approve on or off for a user effect: write questions: - How do I let one trusted user send mailings without admin approval? - Can I revoke auto-approve for a single user? instructions: - text: Enable mailing auto-approve for user {userId}. slots: userId: path.userId - text: Disable per-user mailing auto-approve for {userId}. slots: userId: path.userId method: generated generated: '2026-10-01' - target: $.paths['/api/settings/mailing-auto-approve-tenant'].get update: x-apievangelist-phrasing: intent: Check whether a whole workspace auto-approves mailings effect: read questions: - Does an entire workspace send right after QC without manual approval? - Is tenant-wide mailing auto-approve on for a given tenant? instructions: - text: Check tenant-level mailing auto-approve for tenant {tenantId}. slots: tenantId: query.tenantId - text: Does workspace {tenantId} skip manual mailing approval? Find out. slots: tenantId: query.tenantId method: generated generated: '2026-10-01' - target: $.paths['/api/settings/mailing-auto-approve-tenant'].patch update: x-apievangelist-phrasing: intent: Set workspace-wide mailing auto-approve effect: write questions: - How do I make the whole workspace send immediately after QC with no admin approval? - Can I force every mailing in a tenant back to manual approval? instructions: - text: Turn on tenant-wide mailing auto-approve so the workspace sends after QC. - text: Switch the whole workspace back to manual mailing approval. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/auditor-rules'].get update: x-apievangelist-phrasing: intent: Get the workspace auditor rules effect: read questions: - What content auditor rules and minimum score is my workspace using? - Which phrases does the auditor currently flag? instructions: - text: Show the workspace auditor rules. - text: Fetch our auditor canon and minimum score. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/auditor-rules'].patch update: x-apievangelist-phrasing: intent: Update the workspace auditor rules effect: write questions: - How do I add a banned phrase to the content auditor? - Can I raise the minimum auditor score or turn on the tier-2 model check? instructions: - text: Raise the auditor minimum score for our workspace. - text: Replace the auditor rule list with these phrases and severities. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/send-window'].get update: x-apievangelist-phrasing: intent: Get the workspace send window effect: read questions: - What days and hours is my workspace allowed to send? - Is our sending restricted to a time window or open 24/7? instructions: - text: Show the workspace send window. - text: Check which work days and hours we send in. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/send-window'].patch update: x-apievangelist-phrasing: intent: Set the workspace send window effect: write questions: - How do I limit sending to weekdays during business hours? - Can I remove the send window so the workspace sends 24/7? instructions: - text: Restrict sending to Monday through Friday, 9 to 18 in our timezone. - text: Disable the send window so we send around the clock. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/relay-health'].get update: x-apievangelist-phrasing: intent: Get relay health thresholds effect: read questions: - What bounce auto-pause and block-guard thresholds protect our relays? - When does a dead relay get escalated for manual review? instructions: - text: Show the workspace relay health thresholds. - text: Fetch our relay cooldowns and bounce auto-pause settings. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/relay-health'].patch update: x-apievangelist-phrasing: intent: Change relay health thresholds effect: write questions: - How do I make relays pause sooner when bounces spike? - Can I change relay cooldown seconds without touching the other groups? instructions: - text: Tighten the bounce auto-pause threshold for our relays. - text: Update only the relay cooldown settings. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/min-send-interval'].get update: x-apievangelist-phrasing: intent: Get the default minimum send interval effect: read questions: - How many seconds must pass between sends from one account by default? - Is a minimum send interval turned on for my workspace? instructions: - text: Show the workspace default minimum send interval. - text: Check the per-account send spacing default. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/min-send-interval'].patch update: x-apievangelist-phrasing: intent: Set the default minimum send interval effect: write questions: - How do I space out sends so each account waits between emails? - Can I turn the default minimum send interval off? instructions: - text: Set the default minimum send interval to 120 seconds per account. - text: Turn off the workspace minimum send interval. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/platform-tracking-allowed'].get update: x-apievangelist-phrasing: intent: Check if a tenant may use the shared pixel domain effect: read questions: - Is this tenant allowed to serve open pixels from the shared platform domain? - Has the platform approved our use of the shared tracking domain? instructions: - text: Check whether this tenant may use the shared platform tracking domain. - text: Show the platform-tracking-allowed flag. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/platform-tracking-allowed'].patch update: x-apievangelist-phrasing: intent: Allow or deny the shared pixel domain for a tenant effect: write questions: - How do I approve a tenant to use the shared platform open-pixel domain? - Can I stop an unapproved tenant from burning the shared tracking domain? instructions: - text: Allow this tenant to serve the open pixel from the shared platform domain. - text: Deny shared platform tracking for this tenant. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/notify-rules'].get update: x-apievangelist-phrasing: intent: Get notification routing rules effect: read questions: - Which notifications get routed where in my workspace? - What notification routing rules are configured? instructions: - text: Show the notification routing rules. - text: Fetch where each notification type is routed. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/notify-rules'].patch update: x-apievangelist-phrasing: intent: Update notification routing rules effect: write questions: - How do I change where a notification type is sent? - Can I edit the notification routing rules? instructions: - text: Update the notification routing rules. - text: Route reply notifications to email instead of push. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/crm-event-rules'].get update: x-apievangelist-phrasing: intent: Get CRM event notification rules effect: read questions: - Which CRM events trigger notifications? - How is the CRM event to notification bridge configured? instructions: - text: Show the CRM event notification bridge rules. - text: List which CRM events raise a notification. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/crm-event-rules'].patch update: x-apievangelist-phrasing: intent: Update CRM event notification rules effect: write questions: - How do I get notified when a specific CRM event happens? - Can I stop a CRM event from producing notifications? instructions: - text: Update the CRM event notification bridge rules. - text: Notify me when a deal stage changes in the CRM. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/memory-notes'].get update: x-apievangelist-phrasing: intent: Get my memory notes for AI features effect: read questions: - What memory notes do the AI features know about me? - Where can I read the notes the AI uses as my context? instructions: - text: Show my AI memory notes. - text: Fetch the memory notes saved for my user. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/memory-notes'].patch update: x-apievangelist-phrasing: intent: Update my memory notes for AI features effect: write questions: - How do I tell the AI features something to remember about me? - Can I edit my saved AI memory notes? instructions: - text: Update my AI memory notes. - text: Add to my memory notes that I write in a formal tone. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/trash'].get update: x-apievangelist-phrasing: intent: See how many deleted records are in the trash effect: read questions: - How many soft-deleted contacts, companies, leads and dialogs are waiting in the trash? - What is sitting in the trash before it gets purged? instructions: - text: Show the trash counters. - text: Count the soft-deleted records awaiting restore or purge. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/trash/empty'].post update: x-apievangelist-phrasing: intent: Permanently empty the trash effect: destructive questions: - How do I permanently purge soft-deleted records from the trash? - Can I empty only the deleted contacts and leave other entities in the trash? instructions: - text: Empty the trash permanently with confirmation EMPTY TRASH. - text: Purge only the soft-deleted contacts and companies from the trash. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/delete-data'].delete update: x-apievangelist-phrasing: intent: Delete all workspace data effect: destructive questions: - How do I wipe every record in my workspace? - Is deleting all tenant data reversible? instructions: - text: Delete all data in this workspace. - text: Run the danger-zone wipe of every tenant record. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/account/deactivation-preview'].get update: x-apievangelist-phrasing: intent: Preview what blocks account deactivation effect: read questions: - What phrase do I need to confirm before deactivating my account? - Are active campaigns blocking deactivation of the workspace? instructions: - text: Preview account deactivation and list any blockers. - text: Show the confirmation phrase required to deactivate this account. method: generated generated: '2026-10-01' - target: $.paths['/api/settings/account/deactivate'].post update: x-apievangelist-phrasing: intent: Deactivate the workspace account effect: destructive questions: - How do I deactivate my workspace account? - Is my data kept after I deactivate the account? instructions: - text: Deactivate this account, confirming with the workspace name. - text: Shut down the tenant account using my email as confirmation. method: generated generated: '2026-10-01'