Lelemon
  • Get started
  • Use cases
  • Guides
  • API basics
  • Webhooks
  • SDK, CLI and MCP
  • API reference
  • Changelog
  • v1 (legacy)
Information
Me
    Retrieve the current keyget
API keys
    List scopesget
Agents
    List agentsgetCreate an agentpostRetrieve an agentgetDelete an agentdeleteUpdate an agentpatchActivate an agentpostPause an agentpostList versionsgetRetrieve a versiongetRestore a versionpostList the fixed facts of an agentgetSave a fixed fact of an agentputForget a fixed fact of an agentdelete
Models and templates
    List agent templatesgetList modelsget
Subaccounts
    List subaccountsgetCreate a subaccountpostRetrieve a subaccountgetDelete a subaccountdeleteUpdate a subaccountpatchGive a subaccount its own keypost
WhatsApp
    List WhatsApp connectionsgetCreate a WhatsApp connection linkpostRetrieve a WhatsApp connectiongetRevoke a pending WhatsApp connectiondeleteList WhatsApp phone numbersgetRetrieve a WhatsApp phone numbergetDisconnect a WhatsApp phone numberdeleteChange the agent, label or state of a numberpatchRead the cart and catalog settings of a numbergetTurn the cart button or the catalog icon of a number on or offpatch
Actions
    List actionsgetCreate an actionpostRead the current authorization textgetRotate the signing secret of your actionspostRetrieve the signing secret of an actiongetRetrieve an actiongetDelete an actiondeleteUpdate an actionpatchTest an actionpostRead the approval floor of a shared actiongetSet the approval floor of a shared actionput
MCP servers
    List MCP serversgetConnect an MCP serverpostRetrieve an MCP servergetDisconnect an MCP serverdeleteUpdate an MCP serverpatchList the tools of an MCP servergetDiscover toolspostRead the run identity of an MCP servergetTurn on or rotate the run identity of an MCP serverpostTurn off the run identity of an MCP serverdelete
Data connectors
    Get the lelemon-connector/v1 formatgetValidate a connector documentpostList data connectorsgetRegister a data connectorpostRetrieve a data connectorgetDelete a data connectordeleteUpdate a data connectorpatchRetrieve the signing secret of a data connectorgetRotate the signing secret of a data connectorpostCheck a data connectorpostRetrieve the manifest of a data connectorgetSearch accounts by emailgetRead the card of an account livegetReveal one masked value of an accountpostGet the link of an account actionpostRead a view livegetList who looked at what through a connectorget
Skills
    List skillsgetCreate a skillpostRetrieve a skillgetDelete a skilldeleteUpdate a skillpatch
Agent tools
    List an agent's toolsgetGrant a toolputRemove a tooldelete
Approvals
    List approvalsgetRetrieve an approvalgetApprove an actionpostReject an actionpostAsk for a human review of a decisionpost
Automated decisions
    List automated decisionsgetRetrieve an automated decisiongetAsk for a human review of an automated decisionpost
Team questions
    List team questionsgetRetrieve a team questiongetRead a team question with its contextgetAnswer a team questionpost
Runs
    Give an agent a jobpostList runsgetRetrieve a rungetCancel a runpostAnswer a run that asked somethingpost
Schedules
    Schedule a job for an agentpostList scheduled tasksgetRetrieve a scheduled taskgetDelete a scheduled taskdeleteChange a scheduled taskpatchFire a scheduled task nowpost
Pipelines
    List pipelinesgetCreate a pipelinepostRetrieve a pipelinegetDelete a pipelinedeleteUpdate a pipelinepatchClone a pipelinepostReorder the stages of a pipelinepost
Stages
    List the stages of a pipelinegetCreate a stagepostRetrieve a stagegetDelete a stagedeleteUpdate a stagepatchMake a stage the entry stagepost
Fields
    List the fields of a pipelinegetCreate a fieldpostRetrieve a fieldgetDelete a fielddeleteUpdate a fieldpatch
Routing rules
    List the routing rules of a pipelinegetCreate a routing rulepostRetrieve a routing rulegetDelete a routing ruledeleteUpdate a routing rulepatch
Knowledge
    List collectionsgetCreate a collectionpostSearch the knowledgepostRetrieve a collectiongetDelete a collectiondeleteUpdate a collectionpatchList documentsgetAdd a documentpostRetrieve a documentgetDelete a documentdeleteUpdate a documentpatchLet an agent search a collectionputStop an agent from searching a collectiondelete
Contacts
    List contactsgetCreate a contactpostCreate or update a contact by your own idputRetrieve a contactgetErase a contactdeleteUpdate a contactpatch
Contact fields
    List the contact fieldsgetCreate a contact fieldpostRetrieve a contact fieldgetDelete a contact fielddeleteUpdate a contact fieldpatch
Companies
    List companiesgetCreate a companypostRetrieve a companygetDelete a companydeleteUpdate a companypatch
Lead forms
    List lead formsgetCreate a lead formpostRetrieve a lead formgetDelete a lead formdeleteUpdate a lead formpatch
Suppressions
    Retrieve a suppressionget
Cases
    List casesgetOpen a casepostRetrieve a casegetDelete a casedeleteUpdate a casepatchMove a case to a stagepostAssign a case to a memberpostClose a casepostReopen a casepostTake control of a casepostHand a case back to the agentpostMark a case as readpostMove several cases to a stagepostArchive a casepostBring an archived case backpostMute the contact of a casepostUnmute the contact of a casepostHand a case to a personpostReveal a sensitive field of a casepostEscalate a case to the technical teampostList the escalations of a caseget
Case queue
    Read the attention queue of a memberget
Contact events
    List the events of a contactgetReport a contact eventpostRetrieve a contact eventget
Case reminders
    List the reminders of a casegetAdd a reminder to a casepost
Reminders
    Retrieve a remindergetDelete a reminderdeleteEdit a reminderpatchComplete a reminderpostDismiss a reminderpost
Presence
    Report who is online in your apppostRead the presence settinggetTurn presence on or offput
Organization
    Get the organizationgetRename the organizationpatchGet the organization settingsgetChange the organization settingspatchGet the company profilegetChange the company profilepatch
Case notes
    List the notes of a casegetAdd a note to a casepostRetrieve a notegetDelete a notedeleteEdit a notepatch
Case attachments
    List the files of a casegetUpload a file to a casepostRetrieve a file of a casegetDelete a file of a casedeleteGet the download link of a fileget
Files
    List filesgetUpload a filepostRetrieve a filegetDelete a filedelete
Case messages
    List the messages of a casegetAdd a message to a casepostRedact a messagepost
Case turns
    List the turns the agent took in a caseget
Usage
    Get the usage of your agentsget
Case metrics
    List the times of the cases that changed in a rangeget
Budgets
    List the budgetsgetCreate a monthly budgetpostGet a budgetgetDelete a budgetdeleteChange a budgetpatch
Members
    List the active members of the organizationgetList who invited, changed the role of or removed membersgetRead whether a team member is availablegetMark a team member available or awayputChange the role of a memberpatchChange which cases a member seespatchRemove a member from the organizationdelete
Invitations
    List the invitations of the organizationgetInvite a person to the organizationpostResend an invitationpostCancel an invitationpost
Scheduling
    List the agendasgetCreate an agendapostRetrieve an agendagetUpdate an agendapatchList the team of an agendagetAdd a person to the team of an agendapostRemove a person from the team of an agendadeleteUpdate a person in the team of an agendapatchRead the free slots of an agendagetList meetingsgetBook a meetingpostRetrieve a meetinggetCancel a meetingpostMove a meeting to another slotpost
Webhook endpoints
    List webhook endpointsgetCreate a webhook endpointpostRetrieve a webhook endpointgetDelete a webhook endpointdeleteUpdate a webhook endpointpatchRotate the signing secretpostSend a test eventpostList the deliveries of an endpointget
Events
    Resend an eventpostList the event typesget
Recipient allowlist
    Get the recipient allowlistgetReplace the recipient allowlistput
WhatsApp templates
    List templatesgetCreate a templatepostSync template statusespostRetrieve a templategetDelete a templatedeleteUpdate a templatepatchRender a templatepostSend a test messagepost
WhatsApp messages
    Send a templatepostRetrieve a template messagegetCancel a scheduled messagepost
Triggers
    List triggersgetCreate a triggerpostRetrieve a triggergetDelete a triggerdeleteUpdate a triggerpatchList the runs of a triggerget
Opt-outs
    List opt-outsgetOpt a contact outputClear an opt-outdelete
Campaigns
    List campaignsgetCreate a campaignpostRetrieve a campaigngetDelete a campaigndeleteUpdate a campaignpatchPreview a campaignpostLaunch a campaignpostPause a campaignpostResume a campaignpostCancel a campaignpostList recipientsget
Email domains
    List the sender domainsgetAdd a sender domainpostGet a sender domain with its status and DNS recordsgetRemove a sender domaindeleteChange the default sender or the inbound agent of a domainpatchCheck the DNS records nowpost
Email messages
    Write first by emailpostRetrieve an email messageget
Teams
    List the teamsgetCreate a teampostRetrieve a teamgetDelete a teamdeleteUpdate a teampatchMerge another team into this onepostMove a pipeline into a teamputAdd a member to a team or change their role in itputRemove a member from a teamdelete
Linear
    Get the Linear connectiongetConnect LinearputDisconnect LineardeleteUpdate the Linear connectionpatch
Schemas
powered by Zudoku
Lelemon API
Lelemon API

Case messages


List the messages of a case

GET
https://api.lelemon.cl
/v2/cases/{id}/messages
Bearer (API key)

The whole thread: the contact, the agent, your team and the internal notes (visibility internal). Newest first by default; order=asc reads it from the start. Files of the contact come with a signed url.

Required scope: cases:read.

List the messages of a case › path Parameters

id
​string · pattern: ^cse_[0-9A-Za-z]{22}… · required

The id of the case (cse_…).

List the messages of a case › query Parameters

limit
​integer · min: 1 · max: 100
Default: 20
cursor
​string · maxLength: 512

The nextCursor of the previous page, with the same filters.

order
​string · enum

desc is the newest first. asc reads the thread from the start.

Enum values:
desc
asc
Default: desc

List the messages of a case › Headers

Lelemon-Subaccount
​string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

List the messages of a case › Responses

MessageList
object
​string · enum · required
Enum values:
list
hasMore
​boolean · required
nextCursor
​string | null · required
​Message[] · required
GET/v2/cases/{id}/messages
curl https://api.lelemon.cl/v2/cases/:id/messages \ --header 'Authorization: Bearer <token>'
Example Responses
{ "object": "list", "hasMore": true, "nextCursor": "nextCursor", "data": [ { "object": "message", "id": "msg_4Zq0x8bVw1TqS9mYp3RkLd", "caseId": "cse_4Zq0x8bVw1TqS9mYp3RkLd", "author": "contact", "authorName": "authorName", "visibility": "public", "text": "text", "contentType": "text", "attachments": [ { "type": "image", "mimeType": "image/png", "url": "url", "expiresAt": "2024-08-25T15:00:00Z" } ], "interactive": { "type": "buttons", "body": "body", "header": "header", "footer": "footer", "headerMedia": { "type": "image", "url": "https://cdn.example.com/order.jpg" }, "buttons": [ { "id": "appt:1:confirm", "title": "Confirm" } ] }, "reply": { "id": "appt:1:confirm", "title": "Confirm" }, "order": { "catalogId": "1234567890", "items": [ { "productId": "sku-1", "quantity": 2, "price": 4990, "currency": "CLP" } ] }, "location": { "latitude": -33.4489, "longitude": -70.6693, "name": "Home", "address": "Av. Siempre Viva 742" }, "flowResponse": { "token": "case-42", "data": { "date": "2026-11-02", "time": "10:00" } }, "contact": { "phones": [ { "phone": "+56912345678", "waId": "56912345678" } ] }, "error": { "code": 131026, "message": "Message undeliverable" }, "status": "pending", "createdAt": "2024-08-25T15:00:00Z" } ] }
json
application/json

Add a message to a case

POST
https://api.lelemon.cl
/v2/cases/{id}/messages
Bearer (API key)

author contact needs cases:converse: the agent answers on its own and the answer reaches you by the message.created webhook; when the agent finishes its turn you also get case.turn_completed. If a monthly budget is spent it answers 402 budget_exceeded and nothing is saved: stop and do not retry until the month resets or the limit is raised. author team needs cases:send and a person in control (409 case_agent_in_control otherwise); 422 channel_window_closed on WhatsApp after 24 hours without the person, 422 no_outbound_channel when the case cannot be written back. visibility internal leaves a note for the team and needs only cases:write. attachmentIds sends files already uploaded to the case. interactive sends buttons, a list, a product, a product list or the catalog instead of text, on WhatsApp cases inside the 24 hours window; the tap of the person comes back as a message with reply {id, title}, and a cart as a message with order. Each call sends a new message: use an Idempotency-Key to retry safely. Use dryRun=true first to run the same checks (author scope, case, budget, who is in control, channel, allowlist, 24 hours window, attachments) and get 200 with the message as it would be created, with nothing sent or saved; its id is not saved and attachments comes empty.

Required scope: cases:write.

Add a message to a case › path Parameters

id
​string · pattern: ^cse_[0-9A-Za-z]{22}… · required

The id of the case (cse_…).

Add a message to a case › query Parameters

dryRun
​boolean

When true, the request goes through the same validation as the real one and is answered with what would happen (always 200), and nothing is saved, sent or charged. The answer has the same shape as the real one plus dryRun: true; an id in it is not saved. It does not use the Idempotency-Key.

Add a message to a case › Headers

Lelemon-Subaccount
​string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key
​string · minLength: 1 · maxLength: 255

Makes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.

Add a message to a case › Request Body

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: author, text
type = object · requires: author, text
type = object · requires: author, interactive
type = object · requires: author, attachmentIds
Properties for Variant 1:
CreateContactMessage
author
​string · const · required
Const value: contact
text
​string · minLength: 1 · maxLength: 4096 · required
​object

Who is speaking, for an embedded copilot. Only with author contact. It travels signed to every action and MCP server of this turn as the actor, marked as declared by your key and not verified by Lelemon. It is kept for this turn only.

Add a message to a case › Responses

dryRun=true: the message as it would be created; nothing is sent.

What a dryRun answer adds to the normal one: nothing was saved, sent or charged, and an id in it is not saved.
object
​string · enum · required
Enum values:
message
id
​string · required
caseId
​string · required
author
​string · enum · required
Enum values:
contact
agent
team
authorName
​string | null · required
visibility
​string · enum · required
Enum values:
public
internal
text
​string · required
contentType
​string · required
​MessageAttachment[] · required
status
​string · enum · required

Delivery to the channel of the case.

Enum values:
pending
sent
delivered
read
failed
createdAt
​string · date-time · required
​

The buttons, list, product or catalog the message carried. null on any other message.

​

Set when the person tapped a button or a list row: the id and title they tapped. null otherwise.

​

Set when the person sent a cart from the WhatsApp catalog. text carries their note. null otherwise.

​

Set when the person shared a location (answering a location_request or on their own). text carries it as a sentence the agent reads. null otherwise.

​

Set when the person finished a WhatsApp Flow: the fields they filled in. null otherwise.

​

Set when the person shared their phone answering a contact_request. A contact card the person forwards on their own is not kept. null otherwise.

​

Set when status is failed: why. null on any other status. Read it to know whether to retry, send a template (outside the 24-hour window) or stop.

dryRun
​boolean · const

Present and true when the request had dryRun=true.

Const value:
POST/v2/cases/{id}/messages
curl https://api.lelemon.cl/v2/cases/:id/messages \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "author": "contact", "text": "Where is my order?", "actor": { "id": "user_8841", "role": "staff" } }'
Example Request Body
{ "author": "contact", "text": "Where is my order?", "actor": { "id": "user_8841", "role": "staff" } }
json
application/json
Example Responses
{ "object": "message", "id": "msg_4Zq0x8bVw1TqS9mYp3RkLd", "caseId": "cse_4Zq0x8bVw1TqS9mYp3RkLd", "author": "contact", "authorName": "authorName", "visibility": "public", "text": "text", "contentType": "text", "attachments": [ { "type": "image", "mimeType": "image/png", "url": "url", "expiresAt": "2024-08-25T15:00:00Z" } ], "interactive": { "type": "buttons", "body": "body", "header": "header", "footer": "footer", "headerMedia": { "type": "image", "url": "https://cdn.example.com/order.jpg" }, "buttons": [ { "id": "appt:1:confirm", "title": "Confirm" } ] }, "reply": { "id": "appt:1:confirm", "title": "Confirm" }, "order": { "catalogId": "1234567890", "items": [ { "productId": "sku-1", "quantity": 2, "price": 4990, "currency": "CLP" } ] }, "location": { "latitude": -33.4489, "longitude": -70.6693, "name": "Home", "address": "Av. Siempre Viva 742" }, "flowResponse": { "token": "case-42", "data": { "date": "2026-11-02", "time": "10:00" } }, "contact": { "phones": [ { "phone": "+56912345678", "waId": "56912345678" } ] }, "error": { "code": 131026, "message": "Message undeliverable" }, "status": "pending", "createdAt": "2024-08-25T15:00:00Z", "dryRun": true }
json
application/json

Redact a message

POST
https://api.lelemon.cl
/v2/cases/{id}/messages/{messageId}/redact
Bearer (API key)

Use it when a message holds data that must not stay, for example an ID number or a password the person typed. The text is replaced by [redacted] and the file, transcription and copies of the message in logs, events and agent memory are erased. The rest of the thread stays. It cannot be undone. It is idempotent: redacting a redacted message answers 200 with the same message and publishes nothing. Publishes the webhook message.redacted, which carries ids only: pass it on to every system where you copied the message.

Required scope: cases:delete.

Redact a message › path Parameters

id
​string · pattern: ^cse_[0-9A-Za-z]{22}… · required

The id of the case (cse_…).

messageId
​string · pattern: ^msg_[0-9A-Za-z]{22}… · required

The id of the message (msg_…).

Redact a message › Headers

Lelemon-Subaccount
​string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key
​string · minLength: 1 · maxLength: 255

Makes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.

Redact a message › Responses

Message
object
​string · enum · required
Enum values:
message
id
​string · required
caseId
​string · required
author
​string · enum · required
Enum values:
contact
agent
team
authorName
​string | null · required
visibility
​string · enum · required
Enum values:
public
internal
text
​string · required
contentType
​string · required
​MessageAttachment[] · required
status
​string · enum · required

Delivery to the channel of the case.

Enum values:
pending
sent
delivered
read
failed
createdAt
​string · date-time · required
​

The buttons, list, product or catalog the message carried. null on any other message.

​

Set when the person tapped a button or a list row: the id and title they tapped. null otherwise.

​

Set when the person sent a cart from the WhatsApp catalog. text carries their note. null otherwise.

​

Set when the person shared a location (answering a location_request or on their own). text carries it as a sentence the agent reads. null otherwise.

​

Set when the person finished a WhatsApp Flow: the fields they filled in. null otherwise.

​

Set when the person shared their phone answering a contact_request. A contact card the person forwards on their own is not kept. null otherwise.

​

Set when status is failed: why. null on any other status. Read it to know whether to retry, send a template (outside the 24-hour window) or stop.

POST/v2/cases/{id}/messages/{messageId}/redact
curl https://api.lelemon.cl/v2/cases/:id/messages/:messageId/redact \ --request POST \ --header 'Authorization: Bearer <token>'
Example Responses
{ "object": "message", "id": "msg_4Zq0x8bVw1TqS9mYp3RkLd", "caseId": "cse_4Zq0x8bVw1TqS9mYp3RkLd", "author": "contact", "authorName": "authorName", "visibility": "public", "text": "text", "contentType": "text", "attachments": [ { "type": "image", "mimeType": "image/png", "url": "url", "expiresAt": "2024-08-25T15:00:00Z" } ], "interactive": { "type": "buttons", "body": "body", "header": "header", "footer": "footer", "headerMedia": { "type": "image", "url": "https://cdn.example.com/order.jpg" }, "buttons": [ { "id": "appt:1:confirm", "title": "Confirm" } ] }, "reply": { "id": "appt:1:confirm", "title": "Confirm" }, "order": { "catalogId": "1234567890", "items": [ { "productId": "sku-1", "quantity": 2, "price": 4990, "currency": "CLP" } ] }, "location": { "latitude": -33.4489, "longitude": -70.6693, "name": "Home", "address": "Av. Siempre Viva 742" }, "flowResponse": { "token": "case-42", "data": { "date": "2026-11-02", "time": "10:00" } }, "contact": { "phones": [ { "phone": "+56912345678", "waId": "56912345678" } ] }, "error": { "code": 131026, "message": "Message undeliverable" }, "status": "pending", "createdAt": "2024-08-25T15:00:00Z" }
json
application/json

FilesCase turns