POST communication/previewCampaignProject

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignId	integer	None.
CampaignName	string	None.
Description	string	None.
TenantId	integer	None.
UserId	integer	None.
EmailTemplateId	integer	None.
SmsTemplateId	integer	None.
YapYapTemplateId	integer	None.
SendDate	date	None.
Active	boolean	None.
ObjectTypeId	integer	None.
Status	string	None.
IsCustom	boolean	None.
CustomMessage	string	None.
CustomSendingMethod	string	None.
SendToObjects	string	None.
quickSearchParameters	string	None.
advancedSearchParameters	string	None.
CustomQuery	string	None.
ObjectIds	Collection of integer	None.
IsYapYap	boolean	None.
ContentTemplateId	integer	None.
SearchType	string	None.
SelectAllRecords	boolean	None.
SendMethod	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignId": 1,
  "CampaignName": "sample string 2",
  "Description": "sample string 3",
  "TenantId": 4,
  "UserId": 5,
  "EmailTemplateId": 1,
  "SmsTemplateId": 1,
  "YapYapTemplateId": 1,
  "SendDate": "2026-04-17T11:33:30.5206727+00:00",
  "Active": true,
  "ObjectTypeId": 8,
  "Status": "sample string 9",
  "IsCustom": true,
  "CustomMessage": "sample string 11",
  "CustomSendingMethod": "sample string 12",
  "SendToObjects": "sample string 13",
  "quickSearchParameters": "sample string 14",
  "advancedSearchParameters": "sample string 15",
  "CustomQuery": "sample string 16",
  "ObjectIds": [
    1,
    2
  ],
  "IsYapYap": true,
  "ContentTemplateId": 18,
  "SearchType": "sample string 19",
  "SelectAllRecords": true,
  "SendMethod": "sample string 21"
}

text/html

Sample:

{"CampaignId":1,"CampaignName":"sample string 2","Description":"sample string 3","TenantId":4,"UserId":5,"EmailTemplateId":1,"SmsTemplateId":1,"YapYapTemplateId":1,"SendDate":"2026-04-17T11:33:30.5206727+00:00","Active":true,"ObjectTypeId":8,"Status":"sample string 9","IsCustom":true,"CustomMessage":"sample string 11","CustomSendingMethod":"sample string 12","SendToObjects":"sample string 13","quickSearchParameters":"sample string 14","advancedSearchParameters":"sample string 15","CustomQuery":"sample string 16","ObjectIds":[1,2],"IsYapYap":true,"ContentTemplateId":18,"SearchType":"sample string 19","SelectAllRecords":true,"SendMethod":"sample string 21"}

application/xml, text/xml

Sample:

<CommunicationCampaignModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.SharedLibraries.Models.Template">
  <Active>true</Active>
  <CampaignId>1</CampaignId>
  <CampaignName>sample string 2</CampaignName>
  <ContentTemplateId>18</ContentTemplateId>
  <CustomMessage>sample string 11</CustomMessage>
  <CustomQuery>sample string 16</CustomQuery>
  <CustomSendingMethod>sample string 12</CustomSendingMethod>
  <Description>sample string 3</Description>
  <EmailTemplateId>1</EmailTemplateId>
  <IsCustom>true</IsCustom>
  <IsYapYap>true</IsYapYap>
  <ObjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ObjectIds>
  <ObjectTypeId>8</ObjectTypeId>
  <SearchType>sample string 19</SearchType>
  <SelectAllRecords>true</SelectAllRecords>
  <SendDate>2026-04-17T11:33:30.5206727+00:00</SendDate>
  <SendMethod>sample string 21</SendMethod>
  <SendToObjects>sample string 13</SendToObjects>
  <SmsTemplateId>1</SmsTemplateId>
  <Status>sample string 9</Status>
  <TenantId>4</TenantId>
  <UserId>5</UserId>
  <YapYapTemplateId>1</YapYapTemplateId>
  <advancedSearchParameters>sample string 15</advancedSearchParameters>
  <quickSearchParameters>sample string 14</quickSearchParameters>
</CommunicationCampaignModel>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.