POST api/campaign/add

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignId	integer	None.
CampaignName	string	None.
CampaignStatus	byte	None.
CampaignType	byte	None.
RecurringDays	string	None.
StartDate	date	None.
EndDate	date	None.
Repeat	byte	None.
Mode	byte	None.
CreatedTime	date	None.
UpdatedTime	date	None.
CampaignTime	string	None.
VendorId	integer	None.
LocationId	string	None.
Active	boolean	None.
SMSTemplateId	integer	None.
Filters	Collection of CustomFilterEntity	None.
SMSTemplate	SMSTemplateEntity	None.
RecipientsCount	integer	None.
CustomerFilterType	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignId": 1,
  "CampaignName": "sample string 2",
  "CampaignStatus": 64,
  "CampaignType": 64,
  "RecurringDays": "sample string 5",
  "StartDate": "2025-12-31T16:36:30.61304+05:30",
  "EndDate": "2025-12-31T16:36:30.61304+05:30",
  "Repeat": 64,
  "Mode": 64,
  "CreatedTime": "2025-12-31T16:36:30.61304+05:30",
  "UpdatedTime": "2025-12-31T16:36:30.61304+05:30",
  "CampaignTime": "sample string 11",
  "VendorId": 12,
  "LocationId": "sample string 13",
  "Active": true,
  "SMSTemplateId": 15,
  "Filters": [
    {
      "FilterId": 1,
      "Field": "sample string 2",
      "Expression": "sample string 3",
      "FilterValue": "sample string 4",
      "FilterValueArray": [
        1,
        2
      ],
      "Condition": "sample string 5",
      "VendorId": 6,
      "CampaignId": 1,
      "Active": true,
      "CreatedTime": "2025-12-31T16:36:30.61304+05:30",
      "UpdatedTime": "2025-12-31T16:36:30.61304+05:30"
    },
    {
      "FilterId": 1,
      "Field": "sample string 2",
      "Expression": "sample string 3",
      "FilterValue": "sample string 4",
      "FilterValueArray": [
        1,
        2
      ],
      "Condition": "sample string 5",
      "VendorId": 6,
      "CampaignId": 1,
      "Active": true,
      "CreatedTime": "2025-12-31T16:36:30.61304+05:30",
      "UpdatedTime": "2025-12-31T16:36:30.61304+05:30"
    }
  ],
  "SMSTemplate": {
    "TemplateId": 1,
    "TemplateName": "sample string 2",
    "TemplateContent": "sample string 3",
    "TemplateSubject": "sample string 4",
    "TemplateType": 64,
    "CreatedTime": "2025-12-31T16:36:30.61304+05:30",
    "UpdatedTime": "2025-12-31T16:36:30.61304+05:30",
    "VendorId": 7,
    "LocationId": 1,
    "Active": true,
    "IsActive": true,
    "DLTTemplateId": "sample string 10",
    "IsDLTTemplateApproved": true
  },
  "RecipientsCount": 16,
  "CustomerFilterType": "sample string 17"
}

application/xml, text/xml

Sample:

<CampaignEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pos_crm_api_DAL.Entities">
  <Active>true</Active>
  <CampaignId>1</CampaignId>
  <CampaignName>sample string 2</CampaignName>
  <CampaignStatus>64</CampaignStatus>
  <CampaignTime>sample string 11</CampaignTime>
  <CampaignType>64</CampaignType>
  <CreatedTime>2025-12-31T16:36:30.61304+05:30</CreatedTime>
  <CustomerFilterType>sample string 17</CustomerFilterType>
  <EndDate>2025-12-31T16:36:30.61304+05:30</EndDate>
  <Filters>
    <CustomFilterEntity>
      <Active>true</Active>
      <CampaignId>1</CampaignId>
      <Condition>sample string 5</Condition>
      <CreatedTime>2025-12-31T16:36:30.61304+05:30</CreatedTime>
      <Expression>sample string 3</Expression>
      <Field>sample string 2</Field>
      <FilterId>1</FilterId>
      <FilterValue>sample string 4</FilterValue>
      <FilterValueArray xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </FilterValueArray>
      <UpdatedTime>2025-12-31T16:36:30.61304+05:30</UpdatedTime>
      <VendorId>6</VendorId>
    </CustomFilterEntity>
    <CustomFilterEntity>
      <Active>true</Active>
      <CampaignId>1</CampaignId>
      <Condition>sample string 5</Condition>
      <CreatedTime>2025-12-31T16:36:30.61304+05:30</CreatedTime>
      <Expression>sample string 3</Expression>
      <Field>sample string 2</Field>
      <FilterId>1</FilterId>
      <FilterValue>sample string 4</FilterValue>
      <FilterValueArray xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </FilterValueArray>
      <UpdatedTime>2025-12-31T16:36:30.61304+05:30</UpdatedTime>
      <VendorId>6</VendorId>
    </CustomFilterEntity>
  </Filters>
  <LocationId>sample string 13</LocationId>
  <Mode>64</Mode>
  <RecipientsCount>16</RecipientsCount>
  <RecurringDays>sample string 5</RecurringDays>
  <Repeat>64</Repeat>
  <SMSTemplate>
    <Active>true</Active>
    <CreatedTime>2025-12-31T16:36:30.61304+05:30</CreatedTime>
    <DLTTemplateId>sample string 10</DLTTemplateId>
    <IsActive>true</IsActive>
    <IsDLTTemplateApproved>true</IsDLTTemplateApproved>
    <LocationId>1</LocationId>
    <TemplateContent>sample string 3</TemplateContent>
    <TemplateId>1</TemplateId>
    <TemplateName>sample string 2</TemplateName>
    <TemplateSubject>sample string 4</TemplateSubject>
    <TemplateType>64</TemplateType>
    <UpdatedTime>2025-12-31T16:36:30.61304+05:30</UpdatedTime>
    <VendorId>7</VendorId>
  </SMSTemplate>
  <SMSTemplateId>15</SMSTemplateId>
  <StartDate>2025-12-31T16:36:30.61304+05:30</StartDate>
  <UpdatedTime>2025-12-31T16:36:30.61304+05:30</UpdatedTime>
  <VendorId>12</VendorId>
</CampaignEntity>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.