POST Campaign/AddCampaign

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignID	integer	None.
UniqueIdentifier	string	None.
CampaignDescription	string	None.
CampaignMessage	string	None.
ScheduleFrequencyTypeID	integer	None.
StartDate	date	None.
ExpiryDate	date	None.
FormTemplateID	integer	None.
FormTemplateControlID	integer	None.
CompanyID	integer	None.
CreatedUserID	integer	None.
CreatedDate	date	None.
Active	boolean	None.
CampaignTypeID	integer	None.
CampaignType	CampaignType	None.
CampaignFilters	Collection of CampaignFilter	None.
ScheduleSettings	Collection of ScheduleSetting	None.
TotalRows	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignID": 1,
  "UniqueIdentifier": "sample string 2",
  "CampaignDescription": "sample string 3",
  "CampaignMessage": "sample string 4",
  "ScheduleFrequencyTypeID": 5,
  "StartDate": "2025-07-03T18:50:07.6158+00:00",
  "ExpiryDate": "2025-07-03T18:50:07.6158+00:00",
  "FormTemplateID": 8,
  "FormTemplateControlID": 9,
  "CompanyID": 10,
  "CreatedUserID": 11,
  "CreatedDate": "2025-07-03T18:50:07.6158+00:00",
  "Active": true,
  "CampaignTypeID": 14,
  "CampaignType": {
    "CampaignTypeID": 1,
    "CampaignTypeName": "sample string 2"
  },
  "CampaignFilters": [
    {
      "CampaignFilterID": 1,
      "CampaignID": 2,
      "ParentUniqueIdentifier": "sample string 3",
      "UniqueIdentifier": "sample string 4",
      "Description": "sample string 5",
      "TargetTemplateUniqueIdentifier": "sample string 6",
      "TargetControlUniqueIdentifier": "sample string 7",
      "TargetFormTemplateID": 8,
      "TargetFormTemplateControlID": 9,
      "Value": "sample string 10",
      "CompanyID": 11,
      "Active": true,
      "Order": 13,
      "MethodType": {
        "MethodTypeID": 1,
        "MethodTypeName": "sample string 2"
      },
      "ConditionType": {
        "ConditionTypeID": 1,
        "ConditionTypeName": "sample string 2"
      },
      "ReportConditionOperator": {
        "ReportConditionOperatorID": 1,
        "ReportConditionOperatorName": "sample string 2"
      },
      "MethodTypeID": 14,
      "ConditionTypeID": 15,
      "ReportConditionOperatorID": 16
    },
    {
      "CampaignFilterID": 1,
      "CampaignID": 2,
      "ParentUniqueIdentifier": "sample string 3",
      "UniqueIdentifier": "sample string 4",
      "Description": "sample string 5",
      "TargetTemplateUniqueIdentifier": "sample string 6",
      "TargetControlUniqueIdentifier": "sample string 7",
      "TargetFormTemplateID": 8,
      "TargetFormTemplateControlID": 9,
      "Value": "sample string 10",
      "CompanyID": 11,
      "Active": true,
      "Order": 13,
      "MethodType": {
        "MethodTypeID": 1,
        "MethodTypeName": "sample string 2"
      },
      "ConditionType": {
        "ConditionTypeID": 1,
        "ConditionTypeName": "sample string 2"
      },
      "ReportConditionOperator": {
        "ReportConditionOperatorID": 1,
        "ReportConditionOperatorName": "sample string 2"
      },
      "MethodTypeID": 14,
      "ConditionTypeID": 15,
      "ReportConditionOperatorID": 16
    }
  ],
  "ScheduleSettings": [
    {
      "ScheduleSettingID": 1,
      "ScheduleID": 2,
      "CampaignID": 3,
      "Recurrence": 4,
      "DayID": 5,
      "MonthID": 6,
      "LastRunDate": "2025-07-03T18:50:07.6158+00:00"
    },
    {
      "ScheduleSettingID": 1,
      "ScheduleID": 2,
      "CampaignID": 3,
      "Recurrence": 4,
      "DayID": 5,
      "MonthID": 6,
      "LastRunDate": "2025-07-03T18:50:07.6158+00:00"
    }
  ],
  "TotalRows": 15
}

text/html

Sample:

{"CampaignID":1,"UniqueIdentifier":"sample string 2","CampaignDescription":"sample string 3","CampaignMessage":"sample string 4","ScheduleFrequencyTypeID":5,"StartDate":"2025-07-03T18:50:07.6158+00:00","ExpiryDate":"2025-07-03T18:50:07.6158+00:00","FormTemplateID":8,"FormTemplateControlID":9,"CompanyID":10,"CreatedUserID":11,"CreatedDate":"2025-07-03T18:50:07.6158+00:00","Active":true,"CampaignTypeID":14,"CampaignType":{"CampaignTypeID":1,"CampaignTypeName":"sample string 2"},"CampaignFilters":[{"CampaignFilterID":1,"CampaignID":2,"ParentUniqueIdentifier":"sample string 3","UniqueIdentifier":"sample string 4","Description":"sample string 5","TargetTemplateUniqueIdentifier":"sample string 6","TargetControlUniqueIdentifier":"sample string 7","TargetFormTemplateID":8,"TargetFormTemplateControlID":9,"Value":"sample string 10","CompanyID":11,"Active":true,"Order":13,"MethodType":{"MethodTypeID":1,"MethodTypeName":"sample string 2"},"ConditionType":{"ConditionTypeID":1,"ConditionTypeName":"sample string 2"},"ReportConditionOperator":{"ReportConditionOperatorID":1,"ReportConditionOperatorName":"sample string 2"},"MethodTypeID":14,"ConditionTypeID":15,"ReportConditionOperatorID":16},{"CampaignFilterID":1,"CampaignID":2,"ParentUniqueIdentifier":"sample string 3","UniqueIdentifier":"sample string 4","Description":"sample string 5","TargetTemplateUniqueIdentifier":"sample string 6","TargetControlUniqueIdentifier":"sample string 7","TargetFormTemplateID":8,"TargetFormTemplateControlID":9,"Value":"sample string 10","CompanyID":11,"Active":true,"Order":13,"MethodType":{"MethodTypeID":1,"MethodTypeName":"sample string 2"},"ConditionType":{"ConditionTypeID":1,"ConditionTypeName":"sample string 2"},"ReportConditionOperator":{"ReportConditionOperatorID":1,"ReportConditionOperatorName":"sample string 2"},"MethodTypeID":14,"ConditionTypeID":15,"ReportConditionOperatorID":16}],"ScheduleSettings":[{"ScheduleSettingID":1,"ScheduleID":2,"CampaignID":3,"Recurrence":4,"DayID":5,"MonthID":6,"LastRunDate":"2025-07-03T18:50:07.6158+00:00"},{"ScheduleSettingID":1,"ScheduleID":2,"CampaignID":3,"Recurrence":4,"DayID":5,"MonthID":6,"LastRunDate":"2025-07-03T18:50:07.6158+00:00"}],"TotalRows":15}

application/xml, text/xml

Sample:

<Campaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
  <Active>true</Active>
  <CampaignDescription>sample string 3</CampaignDescription>
  <CampaignFilters>
    <CampaignFilter>
      <Active>true</Active>
      <CampaignFilterID>1</CampaignFilterID>
      <CampaignID>2</CampaignID>
      <CompanyID>11</CompanyID>
      <ConditionType>
        <ConditionTypeID>1</ConditionTypeID>
        <ConditionTypeName>sample string 2</ConditionTypeName>
      </ConditionType>
      <ConditionTypeID>15</ConditionTypeID>
      <Description>sample string 5</Description>
      <MethodType>
        <MethodTypeID>1</MethodTypeID>
        <MethodTypeName>sample string 2</MethodTypeName>
      </MethodType>
      <MethodTypeID>14</MethodTypeID>
      <Order>13</Order>
      <ParentUniqueIdentifier>sample string 3</ParentUniqueIdentifier>
      <ReportConditionOperator>
        <ReportConditionOperatorID>1</ReportConditionOperatorID>
        <ReportConditionOperatorName>sample string 2</ReportConditionOperatorName>
      </ReportConditionOperator>
      <ReportConditionOperatorID>16</ReportConditionOperatorID>
      <TargetControlUniqueIdentifier>sample string 7</TargetControlUniqueIdentifier>
      <TargetFormTemplateControlID>9</TargetFormTemplateControlID>
      <TargetFormTemplateID>8</TargetFormTemplateID>
      <TargetTemplateUniqueIdentifier>sample string 6</TargetTemplateUniqueIdentifier>
      <UniqueIdentifier>sample string 4</UniqueIdentifier>
      <Value>sample string 10</Value>
    </CampaignFilter>
    <CampaignFilter>
      <Active>true</Active>
      <CampaignFilterID>1</CampaignFilterID>
      <CampaignID>2</CampaignID>
      <CompanyID>11</CompanyID>
      <ConditionType>
        <ConditionTypeID>1</ConditionTypeID>
        <ConditionTypeName>sample string 2</ConditionTypeName>
      </ConditionType>
      <ConditionTypeID>15</ConditionTypeID>
      <Description>sample string 5</Description>
      <MethodType>
        <MethodTypeID>1</MethodTypeID>
        <MethodTypeName>sample string 2</MethodTypeName>
      </MethodType>
      <MethodTypeID>14</MethodTypeID>
      <Order>13</Order>
      <ParentUniqueIdentifier>sample string 3</ParentUniqueIdentifier>
      <ReportConditionOperator>
        <ReportConditionOperatorID>1</ReportConditionOperatorID>
        <ReportConditionOperatorName>sample string 2</ReportConditionOperatorName>
      </ReportConditionOperator>
      <ReportConditionOperatorID>16</ReportConditionOperatorID>
      <TargetControlUniqueIdentifier>sample string 7</TargetControlUniqueIdentifier>
      <TargetFormTemplateControlID>9</TargetFormTemplateControlID>
      <TargetFormTemplateID>8</TargetFormTemplateID>
      <TargetTemplateUniqueIdentifier>sample string 6</TargetTemplateUniqueIdentifier>
      <UniqueIdentifier>sample string 4</UniqueIdentifier>
      <Value>sample string 10</Value>
    </CampaignFilter>
  </CampaignFilters>
  <CampaignID>1</CampaignID>
  <CampaignMessage>sample string 4</CampaignMessage>
  <CampaignType>
    <CampaignTypeID>1</CampaignTypeID>
    <CampaignTypeName>sample string 2</CampaignTypeName>
  </CampaignType>
  <CampaignTypeID>14</CampaignTypeID>
  <CompanyID>10</CompanyID>
  <CreatedDate>2025-07-03T18:50:07.6158+00:00</CreatedDate>
  <CreatedUserID>11</CreatedUserID>
  <ExpiryDate>2025-07-03T18:50:07.6158+00:00</ExpiryDate>
  <FormTemplateControlID>9</FormTemplateControlID>
  <FormTemplateID>8</FormTemplateID>
  <ScheduleFrequencyTypeID>5</ScheduleFrequencyTypeID>
  <ScheduleSettings>
    <ScheduleSetting>
      <CampaignID>3</CampaignID>
      <DayID>5</DayID>
      <LastRunDate>2025-07-03T18:50:07.6158+00:00</LastRunDate>
      <MonthID>6</MonthID>
      <Recurrence>4</Recurrence>
      <ScheduleID>2</ScheduleID>
      <ScheduleSettingID>1</ScheduleSettingID>
    </ScheduleSetting>
    <ScheduleSetting>
      <CampaignID>3</CampaignID>
      <DayID>5</DayID>
      <LastRunDate>2025-07-03T18:50:07.6158+00:00</LastRunDate>
      <MonthID>6</MonthID>
      <Recurrence>4</Recurrence>
      <ScheduleID>2</ScheduleID>
      <ScheduleSettingID>1</ScheduleSettingID>
    </ScheduleSetting>
  </ScheduleSettings>
  <StartDate>2025-07-03T18:50:07.6158+00:00</StartDate>
  <TotalRows>15</TotalRows>
  <UniqueIdentifier>sample string 2</UniqueIdentifier>
</Campaign>

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

Response Information

Resource Description

Campaign

Name	Type	Additional information
CampaignID	integer	None.
UniqueIdentifier	string	None.
CampaignDescription	string	None.
CampaignMessage	string	None.
ScheduleFrequencyTypeID	integer	None.
StartDate	date	None.
ExpiryDate	date	None.
FormTemplateID	integer	None.
FormTemplateControlID	integer	None.
CompanyID	integer	None.
CreatedUserID	integer	None.
CreatedDate	date	None.
Active	boolean	None.
CampaignTypeID	integer	None.
CampaignType	CampaignType	None.
CampaignFilters	Collection of CampaignFilter	None.
ScheduleSettings	Collection of ScheduleSetting	None.
TotalRows	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CampaignID": 1,
  "UniqueIdentifier": "sample string 2",
  "CampaignDescription": "sample string 3",
  "CampaignMessage": "sample string 4",
  "ScheduleFrequencyTypeID": 5,
  "StartDate": "2025-07-03T18:50:07.6158+00:00",
  "ExpiryDate": "2025-07-03T18:50:07.6158+00:00",
  "FormTemplateID": 8,
  "FormTemplateControlID": 9,
  "CompanyID": 10,
  "CreatedUserID": 11,
  "CreatedDate": "2025-07-03T18:50:07.6158+00:00",
  "Active": true,
  "CampaignTypeID": 14,
  "CampaignType": {
    "CampaignTypeID": 1,
    "CampaignTypeName": "sample string 2"
  },
  "CampaignFilters": [
    {
      "CampaignFilterID": 1,
      "CampaignID": 2,
      "ParentUniqueIdentifier": "sample string 3",
      "UniqueIdentifier": "sample string 4",
      "Description": "sample string 5",
      "TargetTemplateUniqueIdentifier": "sample string 6",
      "TargetControlUniqueIdentifier": "sample string 7",
      "TargetFormTemplateID": 8,
      "TargetFormTemplateControlID": 9,
      "Value": "sample string 10",
      "CompanyID": 11,
      "Active": true,
      "Order": 13,
      "MethodType": {
        "MethodTypeID": 1,
        "MethodTypeName": "sample string 2"
      },
      "ConditionType": {
        "ConditionTypeID": 1,
        "ConditionTypeName": "sample string 2"
      },
      "ReportConditionOperator": {
        "ReportConditionOperatorID": 1,
        "ReportConditionOperatorName": "sample string 2"
      },
      "MethodTypeID": 14,
      "ConditionTypeID": 15,
      "ReportConditionOperatorID": 16
    },
    {
      "CampaignFilterID": 1,
      "CampaignID": 2,
      "ParentUniqueIdentifier": "sample string 3",
      "UniqueIdentifier": "sample string 4",
      "Description": "sample string 5",
      "TargetTemplateUniqueIdentifier": "sample string 6",
      "TargetControlUniqueIdentifier": "sample string 7",
      "TargetFormTemplateID": 8,
      "TargetFormTemplateControlID": 9,
      "Value": "sample string 10",
      "CompanyID": 11,
      "Active": true,
      "Order": 13,
      "MethodType": {
        "MethodTypeID": 1,
        "MethodTypeName": "sample string 2"
      },
      "ConditionType": {
        "ConditionTypeID": 1,
        "ConditionTypeName": "sample string 2"
      },
      "ReportConditionOperator": {
        "ReportConditionOperatorID": 1,
        "ReportConditionOperatorName": "sample string 2"
      },
      "MethodTypeID": 14,
      "ConditionTypeID": 15,
      "ReportConditionOperatorID": 16
    }
  ],
  "ScheduleSettings": [
    {
      "ScheduleSettingID": 1,
      "ScheduleID": 2,
      "CampaignID": 3,
      "Recurrence": 4,
      "DayID": 5,
      "MonthID": 6,
      "LastRunDate": "2025-07-03T18:50:07.6158+00:00"
    },
    {
      "ScheduleSettingID": 1,
      "ScheduleID": 2,
      "CampaignID": 3,
      "Recurrence": 4,
      "DayID": 5,
      "MonthID": 6,
      "LastRunDate": "2025-07-03T18:50:07.6158+00:00"
    }
  ],
  "TotalRows": 15
}

text/html

Sample:

{"CampaignID":1,"UniqueIdentifier":"sample string 2","CampaignDescription":"sample string 3","CampaignMessage":"sample string 4","ScheduleFrequencyTypeID":5,"StartDate":"2025-07-03T18:50:07.6158+00:00","ExpiryDate":"2025-07-03T18:50:07.6158+00:00","FormTemplateID":8,"FormTemplateControlID":9,"CompanyID":10,"CreatedUserID":11,"CreatedDate":"2025-07-03T18:50:07.6158+00:00","Active":true,"CampaignTypeID":14,"CampaignType":{"CampaignTypeID":1,"CampaignTypeName":"sample string 2"},"CampaignFilters":[{"CampaignFilterID":1,"CampaignID":2,"ParentUniqueIdentifier":"sample string 3","UniqueIdentifier":"sample string 4","Description":"sample string 5","TargetTemplateUniqueIdentifier":"sample string 6","TargetControlUniqueIdentifier":"sample string 7","TargetFormTemplateID":8,"TargetFormTemplateControlID":9,"Value":"sample string 10","CompanyID":11,"Active":true,"Order":13,"MethodType":{"MethodTypeID":1,"MethodTypeName":"sample string 2"},"ConditionType":{"ConditionTypeID":1,"ConditionTypeName":"sample string 2"},"ReportConditionOperator":{"ReportConditionOperatorID":1,"ReportConditionOperatorName":"sample string 2"},"MethodTypeID":14,"ConditionTypeID":15,"ReportConditionOperatorID":16},{"CampaignFilterID":1,"CampaignID":2,"ParentUniqueIdentifier":"sample string 3","UniqueIdentifier":"sample string 4","Description":"sample string 5","TargetTemplateUniqueIdentifier":"sample string 6","TargetControlUniqueIdentifier":"sample string 7","TargetFormTemplateID":8,"TargetFormTemplateControlID":9,"Value":"sample string 10","CompanyID":11,"Active":true,"Order":13,"MethodType":{"MethodTypeID":1,"MethodTypeName":"sample string 2"},"ConditionType":{"ConditionTypeID":1,"ConditionTypeName":"sample string 2"},"ReportConditionOperator":{"ReportConditionOperatorID":1,"ReportConditionOperatorName":"sample string 2"},"MethodTypeID":14,"ConditionTypeID":15,"ReportConditionOperatorID":16}],"ScheduleSettings":[{"ScheduleSettingID":1,"ScheduleID":2,"CampaignID":3,"Recurrence":4,"DayID":5,"MonthID":6,"LastRunDate":"2025-07-03T18:50:07.6158+00:00"},{"ScheduleSettingID":1,"ScheduleID":2,"CampaignID":3,"Recurrence":4,"DayID":5,"MonthID":6,"LastRunDate":"2025-07-03T18:50:07.6158+00:00"}],"TotalRows":15}

application/xml, text/xml

Sample:

<Campaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
  <Active>true</Active>
  <CampaignDescription>sample string 3</CampaignDescription>
  <CampaignFilters>
    <CampaignFilter>
      <Active>true</Active>
      <CampaignFilterID>1</CampaignFilterID>
      <CampaignID>2</CampaignID>
      <CompanyID>11</CompanyID>
      <ConditionType>
        <ConditionTypeID>1</ConditionTypeID>
        <ConditionTypeName>sample string 2</ConditionTypeName>
      </ConditionType>
      <ConditionTypeID>15</ConditionTypeID>
      <Description>sample string 5</Description>
      <MethodType>
        <MethodTypeID>1</MethodTypeID>
        <MethodTypeName>sample string 2</MethodTypeName>
      </MethodType>
      <MethodTypeID>14</MethodTypeID>
      <Order>13</Order>
      <ParentUniqueIdentifier>sample string 3</ParentUniqueIdentifier>
      <ReportConditionOperator>
        <ReportConditionOperatorID>1</ReportConditionOperatorID>
        <ReportConditionOperatorName>sample string 2</ReportConditionOperatorName>
      </ReportConditionOperator>
      <ReportConditionOperatorID>16</ReportConditionOperatorID>
      <TargetControlUniqueIdentifier>sample string 7</TargetControlUniqueIdentifier>
      <TargetFormTemplateControlID>9</TargetFormTemplateControlID>
      <TargetFormTemplateID>8</TargetFormTemplateID>
      <TargetTemplateUniqueIdentifier>sample string 6</TargetTemplateUniqueIdentifier>
      <UniqueIdentifier>sample string 4</UniqueIdentifier>
      <Value>sample string 10</Value>
    </CampaignFilter>
    <CampaignFilter>
      <Active>true</Active>
      <CampaignFilterID>1</CampaignFilterID>
      <CampaignID>2</CampaignID>
      <CompanyID>11</CompanyID>
      <ConditionType>
        <ConditionTypeID>1</ConditionTypeID>
        <ConditionTypeName>sample string 2</ConditionTypeName>
      </ConditionType>
      <ConditionTypeID>15</ConditionTypeID>
      <Description>sample string 5</Description>
      <MethodType>
        <MethodTypeID>1</MethodTypeID>
        <MethodTypeName>sample string 2</MethodTypeName>
      </MethodType>
      <MethodTypeID>14</MethodTypeID>
      <Order>13</Order>
      <ParentUniqueIdentifier>sample string 3</ParentUniqueIdentifier>
      <ReportConditionOperator>
        <ReportConditionOperatorID>1</ReportConditionOperatorID>
        <ReportConditionOperatorName>sample string 2</ReportConditionOperatorName>
      </ReportConditionOperator>
      <ReportConditionOperatorID>16</ReportConditionOperatorID>
      <TargetControlUniqueIdentifier>sample string 7</TargetControlUniqueIdentifier>
      <TargetFormTemplateControlID>9</TargetFormTemplateControlID>
      <TargetFormTemplateID>8</TargetFormTemplateID>
      <TargetTemplateUniqueIdentifier>sample string 6</TargetTemplateUniqueIdentifier>
      <UniqueIdentifier>sample string 4</UniqueIdentifier>
      <Value>sample string 10</Value>
    </CampaignFilter>
  </CampaignFilters>
  <CampaignID>1</CampaignID>
  <CampaignMessage>sample string 4</CampaignMessage>
  <CampaignType>
    <CampaignTypeID>1</CampaignTypeID>
    <CampaignTypeName>sample string 2</CampaignTypeName>
  </CampaignType>
  <CampaignTypeID>14</CampaignTypeID>
  <CompanyID>10</CompanyID>
  <CreatedDate>2025-07-03T18:50:07.6158+00:00</CreatedDate>
  <CreatedUserID>11</CreatedUserID>
  <ExpiryDate>2025-07-03T18:50:07.6158+00:00</ExpiryDate>
  <FormTemplateControlID>9</FormTemplateControlID>
  <FormTemplateID>8</FormTemplateID>
  <ScheduleFrequencyTypeID>5</ScheduleFrequencyTypeID>
  <ScheduleSettings>
    <ScheduleSetting>
      <CampaignID>3</CampaignID>
      <DayID>5</DayID>
      <LastRunDate>2025-07-03T18:50:07.6158+00:00</LastRunDate>
      <MonthID>6</MonthID>
      <Recurrence>4</Recurrence>
      <ScheduleID>2</ScheduleID>
      <ScheduleSettingID>1</ScheduleSettingID>
    </ScheduleSetting>
    <ScheduleSetting>
      <CampaignID>3</CampaignID>
      <DayID>5</DayID>
      <LastRunDate>2025-07-03T18:50:07.6158+00:00</LastRunDate>
      <MonthID>6</MonthID>
      <Recurrence>4</Recurrence>
      <ScheduleID>2</ScheduleID>
      <ScheduleSettingID>1</ScheduleSettingID>
    </ScheduleSetting>
  </ScheduleSettings>
  <StartDate>2025-07-03T18:50:07.6158+00:00</StartDate>
  <TotalRows>15</TotalRows>
  <UniqueIdentifier>sample string 2</UniqueIdentifier>
</Campaign>