Live Direct Marketing Settings API
The Settings API from Live Direct Marketing — 37 operation(s) for settings.
Operations 55
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/settings
Get the full workspace settings document · Get the full workspace settings document
#
Ask an LLM
“Where can I see every setting for my workspace in one response?”
“What does the complete workspace settings document contain?”
Tell an agent
Fetch the entire settings document for my workspace.
Show me all of our workspace settings at once.
PATCH
/api/settings/ai-providers
Update AI provider keys and defaults · Update AI provider keys and defaults
#
Ask an LLM
“How do I change which AI provider my workspace uses by default?”
“Can I set a fallback AI provider and a low-balance threshold?”
Tell an agent
Switch our AI provider to {aiProvider} with default model {defaultAiModel}.
Set {fallbackProvider} as the fallback AI provider and alert below a balance of {balanceThreshold}.
POST
/api/settings/ldm-ai/request
Request LDM AI access or a balance increase · Request LDM AI access / balance increase (tenant → admin)
#
Ask an LLM
“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?”
Tell an agent
Send an LDM AI access request to the admins with the note {note}.
Ask the admins to raise our LDM AI balance.
PATCH
/api/settings/notifications
Update push and email notification preferences · Update notification preferences (push and email)
#
Ask an LLM
“How do I turn email notifications on or off for my account?”
“Can I change the address my notification emails go to?”
Tell an agent
Send my email notifications to {notifyEmail}.
Turn push notifications {pushNotify} using push key {pushKey}.
PATCH
/api/settings/workspace
Rename a workspace or change its currency and language · Update workspace metadata (name, currency, language)
#
Ask an LLM
“How do I rename my workspace?”
“Can I change the default currency and language of the workspace?”
Tell an agent
Rename the workspace to {workspaceName}.
Set the workspace default currency to {defaultCurrency} and language to {defaultLanguage}.
Ask an LLM
“What name is on my user profile right now?”
“Where do I look up my own profile details?”
Tell an agent
Show me my user profile.
Fetch the profile of the user I am logged in as.
Ask an LLM
“How do I change the first and last name on my profile?”
“Can I fix a typo in my surname?”
Tell an agent
Change my profile name to {firstName} {lastName}.
Update my last name to {lastName}.
GET
/api/settings/ui-preferences
Get my dashboard and menu layout preferences · Get current user UI preferences (dashboard blocks, left menu)
#
Ask an LLM
“Which dashboard blocks and left-menu items have I configured?”
“Where are my saved UI layout preferences stored?”
Tell an agent
Show my saved dashboard block and left menu preferences.
Fetch my UI preferences.
PATCH
/api/settings/ui-preferences
Replace my dashboard and menu layout preferences · Replace current user UI preferences
#
Ask an LLM
“How do I save a new dashboard block layout for myself?”
“Can I overwrite my left menu configuration in one go?”
Tell an agent
Replace my UI preferences with the new dashboard and menu layout.
Save this left menu arrangement as my UI preferences.
POST
/api/settings/profile/avatar
Upload a new profile avatar · Upload a new avatar for the current user
#
Ask an LLM
“How do I upload a profile picture?”
“Can I replace my current avatar with a new image file?”
Tell an agent
Upload {file} as my new avatar.
Set my profile picture to the image {file}.
Ask an LLM
“How do I remove my profile picture?”
“Can I go back to having no avatar?”
Tell an agent destructive · confirm first
Delete my avatar.
Remove the profile picture from my account.
Ask an LLM
“How do I change my login password?”
“Do I need my current password to set a new one?”
Tell an agent
Change my password from {currentPassword} to {newPassword}.
Replace my login password with {newPassword}; my current one is {currentPassword}.
GET
/api/settings/security/sessions
List my active login sessions · List active sessions for the current user
#
Ask an LLM
“Which devices am I currently logged in on?”
“How can I see all my active sessions?”
Tell an agent
List my active sessions.
Show every place my account is logged in right now.
DELETE
/api/settings/security/sessions
Log out of all sessions · Revoke all active sessions for the current user
#
Ask an LLM
“How do I sign out of every device at once?”
“Can I kill all of my active sessions if my account was compromised?”
Tell an agent destructive · confirm first
Revoke all of my active sessions.
Log me out everywhere.
DELETE
/api/settings/security/sessions/{sessionId}
Log out one specific session · Revoke a single user session
#
Ask an LLM
“How do I sign out just one device I don't recognize?”
“Can I end a single session without logging out everywhere?”
Tell an agent destructive · confirm first
Revoke session {sessionId}.
Log out the single session {sessionId} and keep the others.
GET
/api/settings/integrations/bo-nalog
Check the bo.nalog.gov.ru integration state · Get bo.nalog.gov.ru integration state: enabled, our rate limit, requests today…
#
Ask an LLM
“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?”
Tell an agent
Show the bo.nalog.gov.ru integration status and today's request count.
Check the last error from the bo.nalog integration.
PATCH
/api/settings/integrations/bo-nalog
Enable or throttle the bo.nalog.gov.ru integration · Update bo.nalog.gov.ru integration: enable/disable, requests-per-minute cap
#
Ask an LLM
“How do I turn off the bo.nalog.gov.ru integration?”
“Can I cap bo.nalog requests per minute?”
Tell an agent
Enable the bo.nalog.gov.ru integration.
Lower the bo.nalog requests-per-minute cap.
GET
/api/settings/integrations/dadata
Get the DaData integration configuration · Get DaData integration configuration
#
Ask an LLM
“How is the DaData integration configured for my workspace?”
“Is DaData enrichment turned on?”
Tell an agent
Show the DaData integration settings.
Fetch our DaData configuration.
PATCH
/api/settings/integrations/dadata
Update the DaData integration configuration · Update DaData integration configuration
#
Ask an LLM
“How do I change the DaData integration settings?”
“Can I turn DaData enrichment off for the workspace?”
Tell an agent
Update the DaData integration configuration.
Disable the DaData integration.
POST
/api/settings/integrations/dadata/reset-counter
Reset the DaData daily request counter · Reset the DaData daily request counter
#
Ask an LLM
“How do I reset the DaData daily request counter?”
“Can I zero out today's DaData usage count?”
Tell an agent
Reset the DaData daily counter.
Zero today's DaData request count.
GET
/api/settings/integrations/inbox-check
Get the Inbox Check integration configuration · Get Inbox Check integration configuration
#
Ask an LLM
“How is Inbox Check set up in my workspace?”
“Which Inbox Check settings are currently saved?”
Tell an agent
Show the Inbox Check integration settings.
Fetch our Inbox Check configuration.
PATCH
/api/settings/integrations/inbox-check
Update the Inbox Check integration configuration · Update Inbox Check integration configuration
#
Ask an LLM
“How do I change the Inbox Check integration settings?”
“Can I switch Inbox Check off?”
Tell an agent
Update the Inbox Check integration configuration.
Disable the Inbox Check integration.
POST
/api/settings/integrations/inbox-check/test
Test the Inbox Check connection · Test the Inbox Check connection
#
Ask an LLM
“Is my Inbox Check connection actually working?”
“How do I verify the Inbox Check credentials I saved?”
Tell an agent
Test the Inbox Check connection.
Run a connectivity check against Inbox Check.
GET
/api/settings/integrations/smartlead
Get the Smartlead integration configuration · Get Smartlead integration configuration
#
Ask an LLM
“How is the Smartlead integration configured?”
“Is Smartlead connected to my workspace?”
Tell an agent
Show the Smartlead integration settings.
Fetch our Smartlead configuration.
PATCH
/api/settings/integrations/smartlead
Update the Smartlead integration configuration · Update Smartlead integration configuration
#
Ask an LLM
“How do I change the Smartlead integration settings?”
“Can I disconnect Smartlead from the workspace?”
Tell an agent
Update the Smartlead integration configuration.
Disable the Smartlead integration.
POST
/api/settings/integrations/smartlead/test
Test the Smartlead connection · Test the Smartlead connection
#
Ask an LLM
“Is my Smartlead connection working?”
“How do I confirm the Smartlead credentials are valid?”
Tell an agent
Test the Smartlead connection.
Run a connectivity check against Smartlead.
GET
/api/settings/integrations/smartlead/placement-matrix
View the Smartlead inbox placement matrix · Smartlead placement matrix — mailbox × provider (#1040)
#
Ask an LLM
“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?”
Tell an agent
Show the Smartlead placement matrix of mailboxes by provider.
Give me the full Smartlead inbox placement grid.
GET
/api/settings/integrations/smartlead/placement-history
View Smartlead placement history for one mailbox · Smartlead placement history for one mailbox × provider cell (#1040)
#
Ask an LLM
“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?”
Tell an agent
Show Smartlead placement history for mailbox {mailbox} at provider {provider}.
Trace how {mailbox} has placed at {provider} over time in Smartlead.
GET
/api/settings/transports
See which mail transports are enabled · Get enabled mail transport flags
#
Ask an LLM
“Which mail transports are switched on for my workspace?”
“What are the current mail transport flags?”
Tell an agent
Show the enabled mail transport flags.
List which sending transports are on.
PATCH
/api/settings/transports
Turn mail transports on or off · Update enabled mail transport flags
#
Ask an LLM
“How do I disable a mail transport we no longer use?”
“Can I enable an additional sending transport?”
Tell an agent
Update the enabled mail transport flags.
Turn off the relay transport.
GET
/api/settings/mailing-auto-approve
List users with mailing auto-approve enabled · List users with mailing auto-approve enabled (SUPER only).
#
Ask an LLM
“Which users can send mailings without manual approval?”
“Who has per-user mailing auto-approve turned on in a given user's tenant?”
Tell an agent
List users with mailing auto-approve in the tenant of user {userId}.
Show who can send without approval in user {userId}'s workspace.
PATCH
/api/settings/users/{userId}/mailing-auto-approve
Turn mailing auto-approve on or off for a user · Enable/disable mailing auto-approve for a user (SUPER only)
#
Ask an LLM
“How do I let one trusted user send mailings without admin approval?”
“Can I revoke auto-approve for a single user?”
Tell an agent
Enable mailing auto-approve for user {userId}.
Disable per-user mailing auto-approve for {userId}.
GET
/api/settings/mailing-auto-approve-tenant
Check whether a whole workspace auto-approves mailings · Get tenant-level mailing auto-approve — whether the WHOLE workspace sends…
#
Ask an LLM
“Does an entire workspace send right after QC without manual approval?”
“Is tenant-wide mailing auto-approve on for a given tenant?”
Tell an agent
Check tenant-level mailing auto-approve for tenant {tenantId}.
Does workspace {tenantId} skip manual mailing approval? Find out.
PATCH
/api/settings/mailing-auto-approve-tenant
Set workspace-wide mailing auto-approve · Set tenant-level mailing auto-approve.
#
Ask an LLM
“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?”
Tell an agent
Turn on tenant-wide mailing auto-approve so the workspace sends after QC.
Switch the whole workspace back to manual mailing approval.
GET
/api/settings/auditor-rules
Get the workspace auditor rules · Get workspace send window (#194): { enabled, workDays[1-7], startTime, endTime…
#
Ask an LLM
“What content auditor rules and minimum score is my workspace using?”
“Which phrases does the auditor currently flag?”
Tell an agent
Show the workspace auditor rules.
Fetch our auditor canon and minimum score.
PATCH
/api/settings/auditor-rules
Update the workspace auditor rules · Partial PATCH of the tenant auditor canon (#100): { minScore?, tier2?…
#
Ask an LLM
“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?”
Tell an agent
Raise the auditor minimum score for our workspace.
Replace the auditor rule list with these phrases and severities.
Ask an LLM
“What days and hours is my workspace allowed to send?”
“Is our sending restricted to a time window or open 24/7?”
Tell an agent
Show the workspace send window.
Check which work days and hours we send in.
PATCH
/api/settings/send-window
Set the workspace send window · Set workspace send window (#194). enabled=false → 24/7 (default). SUPER only
#
Ask an LLM
“How do I limit sending to weekdays during business hours?”
“Can I remove the send window so the workspace sends 24/7?”
Tell an agent
Restrict sending to Monday through Friday, 9 to 18 in our timezone.
Disable the send window so we send around the clock.
GET
/api/settings/relay-health
Get relay health thresholds · Relay health thresholds of the whole workspace (#337): block-guard, bounce…
#
Ask an LLM
“What bounce auto-pause and block-guard thresholds protect our relays?”
“When does a dead relay get escalated for manual review?”
Tell an agent
Show the workspace relay health thresholds.
Fetch our relay cooldowns and bounce auto-pause settings.
PATCH
/api/settings/relay-health
Change relay health thresholds · Set workspace relay health defaults (#337).
#
Ask an LLM
“How do I make relays pause sooner when bounces spike?”
“Can I change relay cooldown seconds without touching the other groups?”
Tell an agent
Tighten the bounce auto-pause threshold for our relays.
Update only the relay cooldown settings.
GET
/api/settings/min-send-interval
Get the default minimum send interval · Get workspace default min send interval per account, seconds (#194). 0 = off
#
Ask an LLM
“How many seconds must pass between sends from one account by default?”
“Is a minimum send interval turned on for my workspace?”
Tell an agent
Show the workspace default minimum send interval.
Check the per-account send spacing default.
PATCH
/api/settings/min-send-interval
Set the default minimum send interval · Set workspace default min send interval per account, seconds 0..86400 (#194).
#
Ask an LLM
“How do I space out sends so each account waits between emails?”
“Can I turn the default minimum send interval off?”
Tell an agent
Set the default minimum send interval to 120 seconds per account.
Turn off the workspace minimum send interval.
GET
/api/settings/platform-tracking-allowed
Check if a tenant may use the shared pixel domain · Get whether SUPER allowed this tenant to serve the open-pixel via the SHARED…
#
Ask an LLM
“Is this tenant allowed to serve open pixels from the shared platform domain?”
“Has the platform approved our use of the shared tracking domain?”
Tell an agent
Check whether this tenant may use the shared platform tracking domain.
Show the platform-tracking-allowed flag.
PATCH
/api/settings/platform-tracking-allowed
Allow or deny the shared pixel domain for a tenant · Allow/deny this tenant to serve the open-pixel via the SHARED platform domain…
#
Ask an LLM
“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?”
Tell an agent
Allow this tenant to serve the open pixel from the shared platform domain.
Deny shared platform tracking for this tenant.
GET
/api/settings/notify-rules
Get notification routing rules · Get the notification routing rules
#
Ask an LLM
“Which notifications get routed where in my workspace?”
“What notification routing rules are configured?”
Tell an agent
Show the notification routing rules.
Fetch where each notification type is routed.
PATCH
/api/settings/notify-rules
Update notification routing rules · Update the notification routing rules
#
Ask an LLM
“How do I change where a notification type is sent?”
“Can I edit the notification routing rules?”
Tell an agent
Update the notification routing rules.
Route reply notifications to email instead of push.
GET
/api/settings/crm-event-rules
Get CRM event notification rules · Get CRM event → notification bridge rules
#
Ask an LLM
“Which CRM events trigger notifications?”
“How is the CRM event to notification bridge configured?”
Tell an agent
Show the CRM event notification bridge rules.
List which CRM events raise a notification.
PATCH
/api/settings/crm-event-rules
Update CRM event notification rules · Update CRM event → notification bridge rules
#
Ask an LLM
“How do I get notified when a specific CRM event happens?”
“Can I stop a CRM event from producing notifications?”
Tell an agent
Update the CRM event notification bridge rules.
Notify me when a deal stage changes in the CRM.
GET
/api/settings/memory-notes
Get my memory notes for AI features · Get the current user memory notes for AI features
#
Ask an LLM
“What memory notes do the AI features know about me?”
“Where can I read the notes the AI uses as my context?”
Tell an agent
Show my AI memory notes.
Fetch the memory notes saved for my user.
PATCH
/api/settings/memory-notes
Update my memory notes for AI features · Update the current user memory notes
#
Ask an LLM
“How do I tell the AI features something to remember about me?”
“Can I edit my saved AI memory notes?”
Tell an agent
Update my AI memory notes.
Add to my memory notes that I write in a formal tone.
GET
/api/settings/trash
See how many deleted records are in the trash · Trash counters: soft-deleted dialogs/leads/contacts/companies awaiting restore…
#
Ask an LLM
“How many soft-deleted contacts, companies, leads and dialogs are waiting in the trash?”
“What is sitting in the trash before it gets purged?”
Tell an agent
Show the trash counters.
Count the soft-deleted records awaiting restore or purge.
POST
/api/settings/trash/empty
Permanently empty the trash · Empty trash — PERMANENTLY delete soft-deleted records.
#
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Empty the trash permanently with confirmation EMPTY TRASH.
Purge only the soft-deleted contacts and companies from the trash.
DELETE
/api/settings/delete-data
Delete all workspace data · Delete all tenant data (irreversible danger-zone action)
#
Ask an LLM
“How do I wipe every record in my workspace?”
“Is deleting all tenant data reversible?”
Tell an agent destructive · confirm first
Delete all data in this workspace.
Run the danger-zone wipe of every tenant record.
GET
/api/settings/account/deactivation-preview
Preview what blocks account deactivation · Preview before account deactivation: confirmation phrase + blockers (active…
#
Ask an LLM
“What phrase do I need to confirm before deactivating my account?”
“Are active campaigns blocking deactivation of the workspace?”
Tell an agent
Preview account deactivation and list any blockers.
Show the confirmation phrase required to deactivate this account.
POST
/api/settings/account/deactivate
Deactivate the workspace account · Deactivate the tenant account (irreversible self-service action).
#
Ask an LLM
“How do I deactivate my workspace account?”
“Is my data kept after I deactivate the account?”
Tell an agent destructive · confirm first
Deactivate this account, confirming with the workspace name.
Shut down the tenant account using my email as confirmation.
Documentation
📖
Documentation
https://developers.live-direct-marketing.online/
📖
APIReference
https://developers.live-direct-marketing.online/api-reference
📖
GettingStarted
https://developers.live-direct-marketing.online/quickstart
📖
Authentication
https://developers.live-direct-marketing.online/authentication
📖
Documentation
https://check.live-direct-marketing.online/docs
📖
APIReference
https://check.live-direct-marketing.online/api/docs