POST api/buildeskapi/campaignlead/create

Request Information

URI Parameters

None.

Body Parameters

CampaignWebhookPostVm
NameDescriptionTypeAdditional information
EventId

integer

None.

LeadQueueId

integer

None.

ApiKey

string

None.

FirstName

string

None.

LastName

string

None.

DialCode

string

None.

Mobile

string

None.

SecondaryNumber

string

None.

CampaignUID

string

None.

Campaign

string

None.

CampaignChannel

string

None.

CampaignChannelUID

string

None.

Platform

string

None.

SubSource

string

None.

CreatedDate

date

None.

Email

string

None.

Remark

string

None.

Remark1

string

None.

UID

string

None.

ProjectId

integer

None.

ProjectUID

string

None.

ProjectName

string

None.

UserId

integer

None.

Location

string

None.

SubLocation

string

None.

UtmCampaign

string

None.

UtmMedium

string

None.

UtmSource

string

None.

UtmTerm

string

None.

GCLId

string

None.

FbId

string

None.

UtmContent

string

None.

Request Formats

application/json, text/json

Sample:
{
  "EventId": 1,
  "LeadQueueId": 1,
  "ApiKey": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "DialCode": "sample string 5",
  "Mobile": "sample string 6",
  "SecondaryNumber": "sample string 7",
  "CampaignUID": "sample string 8",
  "Campaign": "sample string 9",
  "CampaignChannel": "sample string 10",
  "CampaignChannelUID": "sample string 11",
  "Platform": "sample string 12",
  "SubSource": "sample string 13",
  "CreatedDate": "2025-12-07T14:40:27.2411459Z",
  "Email": "sample string 15",
  "Remark": "sample string 16",
  "Remark1": "sample string 17",
  "UID": "sample string 18",
  "ProjectId": 1,
  "ProjectUID": "sample string 19",
  "ProjectName": "sample string 20",
  "UserId": 1,
  "Location": "sample string 21",
  "SubLocation": "sample string 22",
  "UtmCampaign": "sample string 23",
  "UtmMedium": "sample string 24",
  "UtmSource": "sample string 25",
  "UtmTerm": "sample string 26",
  "GCLId": "sample string 27",
  "FbId": "sample string 28",
  "UtmContent": "sample string 29"
}

application/xml, text/xml

Sample:
<CampaignWebhookPostVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.Lead">
  <ApiKey>sample string 2</ApiKey>
  <Campaign>sample string 9</Campaign>
  <CampaignChannel>sample string 10</CampaignChannel>
  <CampaignChannelUID>sample string 11</CampaignChannelUID>
  <CampaignUID>sample string 8</CampaignUID>
  <CreatedDate>2025-12-07T20:10:27.2411459+05:30</CreatedDate>
  <DialCode>sample string 5</DialCode>
  <Email>sample string 15</Email>
  <EventId>1</EventId>
  <FbId>sample string 28</FbId>
  <FirstName>sample string 3</FirstName>
  <GCLId>sample string 27</GCLId>
  <LastName>sample string 4</LastName>
  <LeadQueueId>1</LeadQueueId>
  <Location>sample string 21</Location>
  <Mobile>sample string 6</Mobile>
  <Platform>sample string 12</Platform>
  <ProjectId>1</ProjectId>
  <ProjectName>sample string 20</ProjectName>
  <ProjectUID>sample string 19</ProjectUID>
  <Remark>sample string 16</Remark>
  <Remark1>sample string 17</Remark1>
  <SecondaryNumber>sample string 7</SecondaryNumber>
  <SubLocation>sample string 22</SubLocation>
  <SubSource>sample string 13</SubSource>
  <UID>sample string 18</UID>
  <UserId>1</UserId>
  <UtmCampaign>sample string 23</UtmCampaign>
  <UtmContent>sample string 29</UtmContent>
  <UtmMedium>sample string 24</UtmMedium>
  <UtmSource>sample string 25</UtmSource>
  <UtmTerm>sample string 26</UtmTerm>
</CampaignWebhookPostVm>

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 'CampaignWebhookPostVm'.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional 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>