Skip to main content
PATCH
/
api
/
conversations
/
{id}
/
status
Error
A valid request URL is required to generate request examples
{
  "_id": "665f1a2b3c4d5e6f7a8b9c0d",
  "leadId": "<string>",
  "accountId": "<string>",
  "agentConfigId": "<string>",
  "channel": "whatsapp",
  "leadPhone": "<string>",
  "status": "active",
  "currentStageIndex": 123,
  "messages": [
    {
      "role": "agent",
      "content": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "agentConfigId": "<string>"
    }
  ],
  "messageCount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "campaignId": "<string>",
  "leadEmail": "<string>",
  "currentStageName": "<string>",
  "summary": "<string>",
  "qualificationResult": {
    "qualified": true,
    "reason": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for programmatic access (format nl_live_* or nl_test_*)

Path Parameters

​
id
string
required

MongoDB ObjectId of the conversation.

Body

application/json
​
status
enum<string>
required

The new status for the conversation.

Available options:
completed,
handed_off,
dropped

Response

Status updated successfully. Returns the updated conversation.

​
_id
string
required

MongoDB ObjectId of the conversation.

Example:

"665f1a2b3c4d5e6f7a8b9c0d"

​
leadId
string
required

The ID of the associated lead.

​
accountId
string
required

MongoDB ObjectId of the account (tenant).

​
agentConfigId
string
required

MongoDB ObjectId of the agent configuration used.

​
channel
enum<string>
required

The messaging channel used for this conversation.

Available options:
whatsapp,
telegram,
email
​
leadPhone
string
required

The lead's phone number.

​
status
enum<string>
required

Current status of the conversation.

Available options:
active,
completed,
handed_off,
dropped
​
currentStageIndex
integer
required

Index of the current conversation stage.

​
messages
object[]
required

Ordered list of messages in the conversation.

​
messageCount
integer
required

Total number of messages in the conversation.

​
createdAt
string<date-time>
required

When the conversation was created.

​
updatedAt
string<date-time>
required

When the conversation was last updated.

​
campaignId
string

MongoDB ObjectId of the campaign, if conversation was started by a campaign.

​
leadEmail
string

The lead's email address.

​
currentStageName
string

Name of the current conversation stage.

​
summary
string

LLM-generated summary of the conversation.

​
qualificationResult
object