POST api/campaign/sms/bulk

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BulkSMSId	integer	None.
SMSObjective	string	None.
AllCustomers	boolean	None.
TemplateId	integer	None.
SMSContent	string	None.
SMSTemplate	SMSTemplateEntity	None.
RecipientsCount	integer	None.
CreatedTime	date	None.
UpdatedTime	date	None.
VendorId	integer	None.
LocationId	string	None.
Active	boolean	None.
Filters	Collection of CustomFilterEntity	None.
FailureReason	string	None.
Status	string	None.
SMSSent	integer	None.
SMSCreditUsed	integer	None.
DLTTemplateId	string	None.
CustomerFilterType	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BulkSMSId": 1,
  "SMSObjective": "sample string 2",
  "AllCustomers": true,
  "TemplateId": 4,
  "SMSContent": "sample string 5",
  "SMSTemplate": {
    "TemplateId": 1,
    "TemplateName": "sample string 2",
    "TemplateContent": "sample string 3",
    "TemplateSubject": "sample string 4",
    "TemplateType": 64,
    "CreatedTime": "2025-12-31T16:42:38.5012453+05:30",
    "UpdatedTime": "2025-12-31T16:42:38.5012453+05:30",
    "VendorId": 7,
    "LocationId": 1,
    "Active": true,
    "IsActive": true,
    "DLTTemplateId": "sample string 10",
    "IsDLTTemplateApproved": true
  },
  "RecipientsCount": 6,
  "CreatedTime": "2025-12-31T16:42:38.5012453+05:30",
  "UpdatedTime": "2025-12-31T16:42:38.5012453+05:30",
  "VendorId": 9,
  "LocationId": "sample string 10",
  "Active": true,
  "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:42:38.5012453+05:30",
      "UpdatedTime": "2025-12-31T16:42:38.5012453+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:42:38.5012453+05:30",
      "UpdatedTime": "2025-12-31T16:42:38.5012453+05:30"
    }
  ],
  "FailureReason": "sample string 12",
  "Status": "sample string 13",
  "SMSSent": 14,
  "SMSCreditUsed": 15,
  "DLTTemplateId": "sample string 16",
  "CustomerFilterType": "sample string 17"
}

application/xml, text/xml

Sample:

<BulkSMSEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pos_crm_api_DAL.Entities">
  <Active>true</Active>
  <AllCustomers>true</AllCustomers>
  <BulkSMSId>1</BulkSMSId>
  <CreatedTime>2025-12-31T16:42:38.5012453+05:30</CreatedTime>
  <CustomerFilterType>sample string 17</CustomerFilterType>
  <DLTTemplateId>sample string 16</DLTTemplateId>
  <FailureReason>sample string 12</FailureReason>
  <Filters>
    <CustomFilterEntity>
      <Active>true</Active>
      <CampaignId>1</CampaignId>
      <Condition>sample string 5</Condition>
      <CreatedTime>2025-12-31T16:42:38.5012453+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:42:38.5012453+05:30</UpdatedTime>
      <VendorId>6</VendorId>
    </CustomFilterEntity>
    <CustomFilterEntity>
      <Active>true</Active>
      <CampaignId>1</CampaignId>
      <Condition>sample string 5</Condition>
      <CreatedTime>2025-12-31T16:42:38.5012453+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:42:38.5012453+05:30</UpdatedTime>
      <VendorId>6</VendorId>
    </CustomFilterEntity>
  </Filters>
  <LocationId>sample string 10</LocationId>
  <RecipientsCount>6</RecipientsCount>
  <SMSContent>sample string 5</SMSContent>
  <SMSCreditUsed>15</SMSCreditUsed>
  <SMSObjective>sample string 2</SMSObjective>
  <SMSSent>14</SMSSent>
  <SMSTemplate>
    <Active>true</Active>
    <CreatedTime>2025-12-31T16:42:38.5012453+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:42:38.5012453+05:30</UpdatedTime>
    <VendorId>7</VendorId>
  </SMSTemplate>
  <Status>sample string 13</Status>
  <TemplateId>4</TemplateId>
  <UpdatedTime>2025-12-31T16:42:38.5012453+05:30</UpdatedTime>
  <VendorId>9</VendorId>
</BulkSMSEntity>

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.