Live Direct Marketing Dialogs API
The Dialogs API from Live Direct Marketing — 44 operation(s) for dialogs.
Operations 49
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/dialogs
List email dialogs with filters · List dialogs with filters (channel, status, folder, etc.)
#
Ask an LLM
“Can I filter my inbox dialogs by channel, status or folder?”
“Which conversations with a given contact or company are in my dialogs inbox?”
Tell an agent
List dialogs on channel {channel} with status {status}.
Show all dialogs with contact {contactId} between {dateFrom} and {dateTo}.
Ask an LLM
“How many dialogs do I have in total across my inbox?”
“What are the overall counts and totals for my email conversations?”
Tell an agent
Give me the aggregate statistics for my dialogs.
Summarize my dialog inbox totals.
POST
/api/dialogs/badges
Get dialog badges for a set of leads · Get bulk dialog badges for a set of leads
#
Ask an LLM
“Can I fetch dialog badges for many leads in one call?”
“Which of my leads have unread or flagged conversations, shown as badges?”
Tell an agent
Fetch the dialog badges for this batch of leads.
Get bulk conversation badges for the leads on my pipeline board.
GET
/api/dialogs/accounts
List email accounts used in dialogs · List email accounts used in dialogs
#
Ask an LLM
“Which mailbox accounts are my dialogs coming through?”
“Can I see only the active email accounts that have conversations?”
Tell an agent
List the email accounts used in my dialogs.
Show dialog email accounts with activeOnly set to {activeOnly}.
Ask an LLM
“What folders are my dialogs organized into?”
“Can I see the stored dialog folders for just one mailbox account?”
Tell an agent
List my dialog folders.
Show the dialog folders for account {accountId}.
GET
/api/dialogs/thread/{threadId}
Get a full dialog thread · Get a full dialog thread by thread ID
#
Ask an LLM
“How do I see every message in an email thread at once?”
“Can I load the whole back-and-forth of a conversation by its thread ID?”
Tell an agent
Show me the full thread {threadId}.
Load all messages in conversation thread {threadId}.
POST
/api/dialogs/bulk
Apply a bulk action to many dialogs · Perform a bulk action on multiple dialogs
#
Ask an LLM
“Can I apply one action to many dialogs at the same time?”
“Is there a way to update a whole selection of conversations in one request?”
Tell an agent
Apply this bulk action to all the dialogs I selected.
Run a bulk action across these dialogs in one go.
Ask an LLM
“Can I move conversations into a different folder on the mail server?”
“How do I file dialogs into an IMAP folder like Archive?”
Tell an agent
Move these dialogs into the IMAP folder I name.
File the selected conversations into another IMAP folder on the mail server.
POST
/api/dialogs/imap/delete
Permanently delete dialogs from IMAP · Permanently delete dialogs from IMAP
#
Ask an LLM
“Can I permanently remove messages from the mail server itself?”
“Is deleting dialogs from IMAP reversible?”
Tell an agent destructive · confirm first
Permanently delete these dialogs from the IMAP mailbox.
Erase the selected messages from the mail server for good.
GET
/api/dialogs/imap/folders
List live IMAP folders for an account · List IMAP folders live from the mail server
#
Ask an LLM
“What folders actually exist on the mail server for this mailbox right now?”
“Can I read the IMAP folder list live rather than from the cache?”
Tell an agent
List the live IMAP folders for account {accountId}.
Fetch the folder tree from the mail server for mailbox {accountId}.
Ask an LLM
“Can I create a new folder on the mail server from the app?”
“How do I add an IMAP folder for sorting replies?”
Tell an agent
Create a new IMAP folder on my mailbox.
Add a folder called Hot Replies on the mail server.
Ask an LLM
“Can I rename an existing folder on the mail server?”
“Is it possible to change an IMAP folder's name without recreating it?”
Tell an agent
Rename this IMAP folder on my mailbox.
Change the name of the mail server folder Leads to Qualified.
Ask an LLM
“Can I remove a folder from the mail server?”
“What happens if I delete an IMAP folder I no longer use?”
Tell an agent destructive · confirm first
Delete this IMAP folder from my mailbox.
Remove the unused folder from the mail server.
Ask an LLM
“Which emails are still waiting in my outbox to be sent?”
“Can I see only scheduled outbox sends or only failed ones?”
Tell an agent
List outbox entries with status {status}.
Show my scheduled outbox sends, page {page}.
GET
/api/dialogs/outbox/{id}/history
Read the history of one outbox task · Read safe, paginated history for one durable outbox task
#
Ask an LLM
“What happened to a particular queued email over time?”
“Can I page through the delivery history of one outbox send?”
Tell an agent
Show the history of outbox entry {id}.
Get the next {limit} history events for outbox task {id} after cursor {cursor}.
PATCH
/api/dialogs/outbox/{id}
Reschedule a queued outbox send · Reschedule (or clear schedule on) a queued outbox send
#
Ask an LLM
“Can I change when a queued email is scheduled to go out?”
“Is it possible to clear the schedule on an outbox send so it goes immediately?”
Tell an agent
Reschedule outbox entry {id} to a new send time.
Clear the scheduled time on queued send {id}.
DELETE
/api/dialogs/outbox/{id}
Cancel a queued or failed outbox send · Cancel a queued or failed outbox entry
#
Ask an LLM
“Can I stop an email that is queued but hasn't gone out yet?”
“How do I cancel a failed send sitting in the outbox?”
Tell an agent destructive · confirm first
Cancel outbox entry {id}.
Stop the queued email {id} from being sent.
Ask an LLM
“How many emails are queued, sent or failed in my outbox?”
“What does the send queue look like right now?”
Tell an agent
Show me outbox queue statistics.
Count my queued and failed outgoing emails.
POST
/api/dialogs/outbox/{id}/retry
Retry a failed outbox send · Manually retry a failed outbox entry
#
Ask an LLM
“Can I manually resend an email that failed in the outbox?”
“What do I do when an outbox entry fails to deliver?”
Tell an agent
Retry failed outbox entry {id}.
Try sending outbox email {id} again.
POST
/api/dialogs/outbox/{id}/refresh-control
Check placement of a control email · Poll inbox-check for the placement status of a control email
#
Ask an LLM
“Did the control copy of my send land in the inbox or in spam?”
“Can I poll the inbox check for a control email's placement status?”
Tell an agent
Refresh the control email placement for outbox entry {id}.
Poll inbox placement of the control copy for send {id}.
POST
/api/dialogs/outbox/{id}/resend-control
Resend the control copy of an outbox send · Re-enqueue the control-copy send for an outbox entry
#
Ask an LLM
“Can I send the control copy of an outbox email again?”
“What if the placement-test copy of a send never arrived?”
Tell an agent
Re-enqueue the control copy for outbox entry {id}.
Send the placement control email for {id} again.
Ask an LLM
“Can I open one specific dialog by its ID?”
“What are the details of a single email conversation record?”
Tell an agent
Get dialog {id}.
Open the conversation record {id}.
PATCH
/api/dialogs/{id}
Update a dialog or edit a queued message · Update dialog metadata or edit a queued outbox message
#
Ask an LLM
“Can I edit an email that's queued in the outbox before it sends?”
“Is it possible to change a dialog's metadata after it arrives?”
Tell an agent
Update the metadata on dialog {id}.
Edit the text of queued outbox message {id} before it sends.
Ask an LLM
“How do I delete a conversation I don't need?”
“Can a deleted dialog still be restored afterwards?”
Tell an agent destructive · confirm first
Delete dialog {id}.
Move conversation {id} to the trash.
Ask an LLM
“Can I mark a conversation as read without opening it?”
“How do I clear the unread state on a dialog?”
Tell an agent
Mark dialog {id} as read.
Clear the unread flag on conversation {id}.
Ask an LLM
“Can I star an important conversation to find it later?”
“How do I remove the star from a dialog?”
Tell an agent
Toggle the star on dialog {id}.
Star conversation {id}.
POST
/api/dialogs/{id}/snooze
Snooze a dialog until later · Snooze a dialog until a future timestamp
#
Ask an LLM
“Can I hide a conversation until next week and have it come back?”
“Is there a way to snooze a dialog to a future time?”
Tell an agent
Snooze dialog {id} until Monday morning.
Hide conversation {id} until a later date.
Ask an LLM
“Can I bring a snoozed conversation back right now?”
“What if I need a snoozed dialog before its snooze time ends?”
Tell an agent
Unsnooze dialog {id} now.
Bring snoozed conversation {id} back to the inbox.
Ask an LLM
“Can I get reminded to follow up on a conversation?”
“Is it possible to attach a follow-up reminder to a dialog?”
Tell an agent
Set a follow-up reminder on dialog {id}.
Remind me about conversation {id} on Friday.
POST
/api/dialogs/{id}/reminder/clear
Clear a dialog reminder · Clear an existing reminder on a dialog
#
Ask an LLM
“How do I remove a reminder I set on a conversation?”
“Can I cancel a follow-up reminder that's no longer needed?”
Tell an agent
Clear the reminder on dialog {id}.
Remove the follow-up reminder from conversation {id}.
POST
/api/dialogs/{id}/classify-reply
Classify a reply with AI · Run AI reply classification on a dialog
#
Ask an LLM
“Can AI tell me whether a reply is interested, out of office or a refusal?”
“How do I get an automatic classification of an incoming reply?”
Tell an agent
Run AI reply classification on dialog {id}.
Have AI categorize the reply in conversation {id}.
POST
/api/dialogs/{id}/mark-type
Manually set a dialog's message type · Manually mark the message type / marking of a dialog
#
Ask an LLM
“Can I override the message type the system assigned to a reply?”
“What if a dialog's marking is wrong and I want to set it by hand?”
Tell an agent
Manually mark the message type on dialog {id}.
Set the marking on conversation {id} to interested.
POST
/api/dialogs/{id}/action/unsubscribe
Process an unsubscribe from a dialog · Process an unsubscribe action triggered by a dialog
#
Ask an LLM
“A recipient replied asking to unsubscribe; how do I process that from the conversation?”
“Can I trigger the unsubscribe action straight from a dialog?”
Tell an agent
Process the unsubscribe request in dialog {id}.
Unsubscribe the sender of conversation {id}.
POST
/api/dialogs/{id}/action/bounce
Process a bounce on a dialog · Process a bounce action (hard or soft) on a dialog
#
Ask an LLM
“How should a hard or soft bounce message be handled from the inbox?”
“Can I record a dialog as a bounce so the address is treated accordingly?”
Tell an agent
Process dialog {id} as a hard bounce.
Apply the soft bounce action to conversation {id}.
POST
/api/dialogs/{id}/action/spam
Mark a dialog as spam · Mark a dialog as spam and apply side effects
#
Ask an LLM
“Can I flag an incoming conversation as spam?”
“What side effects happen when I mark a dialog as spam?”
Tell an agent
Mark dialog {id} as spam.
Flag conversation {id} as junk and apply the spam actions.
POST
/api/dialogs/{id}/action/stop-list
Add a dialog's sender to the stop list · Add the dialog sender to the stop-list
#
Ask an LLM
“Can I block the sender of a conversation from future mailings?”
“How do I put the person who replied onto the stop list from their dialog?”
Tell an agent
Add the sender of dialog {id} to the stop list.
Never email the person from conversation {id} again.
POST
/api/dialogs/{id}/generate-reply
Generate an AI reply draft · Generate an AI reply draft for a dialog
#
Ask an LLM
“Can AI draft a response to a conversation for me?”
“Is there a way to get a suggested reply before I send anything?”
Tell an agent
Generate an AI reply draft for dialog {id}.
Draft a suggested response to conversation {id} without sending it.
POST
/api/dialogs/{id}/reply
Reply to a dialog · Reply to a dialog (optionally send via SMTP with attachments).
#
Ask an LLM
“How do I answer an email conversation and send it over SMTP?”
“Can I attach files when replying to a dialog?”
Tell an agent
Reply to dialog {id} with: {bodyText}
Reply to conversation {id} from account {accountId} and send via SMTP.
POST
/api/dialogs/{id}/forward
Forward a dialog to a new recipient · Forward an existing dialog to a new recipient.
#
Ask an LLM
“Can I forward a conversation to a colleague's email?”
“Is it possible to add a note when forwarding a dialog?”
Tell an agent
Forward dialog {id} to {toEmail}.
Forward conversation {id} to {toName} at {toEmail} with the note {bodyText}.
Ask an LLM
“How do I send a brand-new outbound email that isn't a reply?”
“Can I schedule a new email to go out later in the recipient's timezone?”
Tell an agent
Send a new email to {toEmail} with subject {subject} from account {accountId}.
Compose an email to {toEmail} titled {subject} and schedule it for {scheduledAt} in {timezone}.
POST
/api/dialogs/{id}/auto-link
Auto-link a dialog to CRM records · Auto-link a dialog to matching contact/company/lead
#
Ask an LLM
“Can a conversation be matched to its contact, company and lead automatically?”
“What if an email isn't linked to anyone in my CRM yet?”
Tell an agent
Auto-link dialog {id} to the matching contact, company and lead.
Match conversation {id} to existing CRM records.
Ask an LLM
“Can I turn an interested reply into a new lead?”
“How do I start a deal straight from an email conversation?”
Tell an agent
Create a new lead from dialog {id}.
Turn conversation {id} into a lead in the pipeline.
POST
/api/dialogs/{id}/extract-entities
Extract company and contact details with AI · Run AI entity extraction (company/contact) on a dialog
#
Ask an LLM
“Can AI pull the company and contact details out of an email signature?”
“Which company and person does a conversation mention, according to AI extraction?”
Tell an agent
Run AI entity extraction on dialog {id}.
Pull company and contact details out of conversation {id}.
POST
/api/dialogs/{id}/track/set-token
Set the tracking token on a dialog · Set the tracking token on a dialog (internal use)
#
Ask an LLM
“Can I assign an open-and-click tracking token to a specific dialog?”
“Where is the internal tracking token for a conversation set?”
Tell an agent
Set the tracking token on dialog {id}.
Attach an internal tracking token to conversation {id}.
Ask an LLM
“How is an email open recorded against a conversation?”
“Can I log that a recipient opened my message?”
Tell an agent
Record an email-open tracking event.
Log that the recipient opened this tracked email.
Ask an LLM
“How is a link click in a sent email recorded?”
“Can I log that a recipient clicked a link in my message?”
Tell an agent
Record an email-click tracking event.
Log that the recipient clicked a link in this tracked email.
POST
/api/dialogs/{id}/restore
Restore a deleted dialog · Restore a deleted dialog (status DELETED → NEW)
#
Ask an LLM
“Can I get back a conversation I deleted by mistake?”
“How do I move a dialog out of the trash and back to new?”
Tell an agent
Restore deleted dialog {id}.
Bring conversation {id} back from the trash.
DELETE
/api/dialogs/{id}/purge
Permanently purge a trashed dialog · PERMANENTLY delete a trashed dialog (requires status DELETED). Irreversible
#
Ask an LLM
“Can I permanently erase a conversation that's already in the trash?”
“Is purging a trashed dialog irreversible?”
Tell an agent destructive · confirm first
Permanently purge trashed dialog {id}.
Erase conversation {id} from the trash for good.
POST
/api/dialogs/{id}/share
Create a public share link for a dialog · Generate a public share token for a dialog (30-day TTL)
#
Ask an LLM
“Can I share a conversation with someone outside the app via a link?”
“How long does a shared dialog link stay valid?”
Tell an agent
Generate a public share link for dialog {id}.
Create a 30-day share token for conversation {id}.
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