POST api/CreateCampaign

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Name	string	None.
Title	string	None.
Type	string	None.
Message	string	None.
Subject	string	None.
Url	string	None.
LeadSourceId	integer	None.
SubSource	string	None.
CampaignCompanyIvrs	Collection of integer	None.
CampaignSegments	Collection of integer	None.
Documents	Collection of ImageVM	None.
StartDateTime	date	None.
EndDateTime	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Title": "sample string 2",
  "Type": "sample string 3",
  "Message": "sample string 4",
  "Subject": "sample string 5",
  "Url": "sample string 6",
  "LeadSourceId": 1,
  "SubSource": "sample string 7",
  "CampaignCompanyIvrs": [
    1,
    2
  ],
  "CampaignSegments": [
    1,
    2
  ],
  "Documents": [
    {
      "Id": 1,
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Category": "sample string 5",
      "Base64Url": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Category": "sample string 5",
      "Base64Url": "sample string 6"
    }
  ],
  "StartDateTime": "2025-12-07T14:36:05.8352656Z",
  "EndDateTime": "2025-12-07T14:36:05.8352656Z"
}

application/xml, text/xml

Sample:

<SaveCampaignVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models.CampaignModels">
  <CampaignCompanyIvrs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </CampaignCompanyIvrs>
  <CampaignSegments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </CampaignSegments>
  <Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
    <d2p1:ImageVM>
      <d2p1:Base64Url>sample string 6</d2p1:Base64Url>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 4</d2p1:Type>
      <d2p1:Url>sample string 2</d2p1:Url>
    </d2p1:ImageVM>
    <d2p1:ImageVM>
      <d2p1:Base64Url>sample string 6</d2p1:Base64Url>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 4</d2p1:Type>
      <d2p1:Url>sample string 2</d2p1:Url>
    </d2p1:ImageVM>
  </Documents>
  <EndDateTime>2025-12-07T20:06:05.8352656+05:30</EndDateTime>
  <LeadSourceId>1</LeadSourceId>
  <Message>sample string 4</Message>
  <Name>sample string 1</Name>
  <StartDateTime>2025-12-07T20:06:05.8352656+05:30</StartDateTime>
  <SubSource>sample string 7</SubSource>
  <Subject>sample string 5</Subject>
  <Title>sample string 2</Title>
  <Type>sample string 3</Type>
  <Url>sample string 6</Url>
</SaveCampaignVm>

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

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>