POST api/buildeskapi/lead/conversation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EventId	integer	None.
ApiKey	string	None.
LeadId	integer	None.
ConversationId	string	None.
Conversation	Collection of Object	None.
Summary	string	None.
AssistantId	string	None.
Status	string	None.
StartedAt	date	None.
EndedAt	date	None.
Budget	string	None.
ProjectPreference	string	None.
CallBackSchedule	string	None.
SiteVisitSchedule	string	None.
Lead	LeadConversationLeadVm	None.

Request Formats

application/json, text/json

Sample:

{
  "EventId": 1,
  "ApiKey": "sample string 2",
  "LeadId": 1,
  "ConversationId": "sample string 3",
  "Conversation": null,
  "Summary": "sample string 4",
  "AssistantId": "sample string 5",
  "Status": "sample string 6",
  "StartedAt": "2026-09-08T10:29:25.4794104Z",
  "EndedAt": "2026-09-08T10:29:25.4794104Z",
  "Budget": "sample string 7",
  "ProjectPreference": "sample string 8",
  "CallBackSchedule": "sample string 9",
  "SiteVisitSchedule": "sample string 10",
  "Lead": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "DialCode": "sample string 3",
    "Mobile": "sample string 4",
    "SecondaryNumber": "sample string 5",
    "Email": "sample string 6",
    "Remark": "sample string 7",
    "SubSource": "sample string 8",
    "Platform": "sample string 9",
    "ProjectName": "sample string 10",
    "ProjectUID": "sample string 11",
    "ProjectId": 1,
    "Location": "sample string 12",
    "SubLocation": "sample string 13",
    "UID": "sample string 14",
    "UtmCampaign": "sample string 15",
    "UtmMedium": "sample string 16",
    "UtmSource": "sample string 17",
    "UtmTerm": "sample string 18",
    "GCLId": "sample string 19",
    "FbId": "sample string 20",
    "UtmContent": "sample string 21"
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LeadConversationVm'.

Response Information

Resource Description

Response

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Description	string	None.
Data	Object	None.
Count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:

<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>