GET api/Campaign?SearchStr={SearchStr}

Request Information

URI Parameters

Name	Description	Type	Additional information
SearchStr		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Campaign

Name	Type	Additional information
CampaignId	string	None.
PortalCustomersId	string	None.
Id	string	None.
Role	string	None.
CampaignName	string	None.
Description	string	None.
Cost	decimal number	None.
RevenuePerLead	decimal number	None.
Status	string	None.
Tags	string	None.
CreatedById	string	None.
CreatedDate	date	None.
UpdatedById	string	None.
UpdatedDate	date	None.
PushCode	string	None.
InactiveMessage	string	None.
EmailId	string	None.
FolderId	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CampaignId": "sample string 1",
    "PortalCustomersId": "sample string 2",
    "Id": "sample string 3",
    "Role": "sample string 4",
    "CampaignName": "sample string 5",
    "Description": "sample string 6",
    "Cost": 7.0,
    "RevenuePerLead": 8.0,
    "Status": "sample string 9",
    "Tags": "sample string 10",
    "CreatedById": "sample string 11",
    "CreatedDate": "2025-05-13T14:09:24.1948896+00:00",
    "UpdatedById": "sample string 13",
    "UpdatedDate": "2025-05-13T14:09:24.1948896+00:00",
    "PushCode": "sample string 15",
    "InactiveMessage": "sample string 16",
    "EmailId": "sample string 17",
    "FolderId": "sample string 18"
  },
  {
    "CampaignId": "sample string 1",
    "PortalCustomersId": "sample string 2",
    "Id": "sample string 3",
    "Role": "sample string 4",
    "CampaignName": "sample string 5",
    "Description": "sample string 6",
    "Cost": 7.0,
    "RevenuePerLead": 8.0,
    "Status": "sample string 9",
    "Tags": "sample string 10",
    "CreatedById": "sample string 11",
    "CreatedDate": "2025-05-13T14:09:24.1948896+00:00",
    "UpdatedById": "sample string 13",
    "UpdatedDate": "2025-05-13T14:09:24.1948896+00:00",
    "PushCode": "sample string 15",
    "InactiveMessage": "sample string 16",
    "EmailId": "sample string 17",
    "FolderId": "sample string 18"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <Campaign>
    <CampaignId>sample string 1</CampaignId>
    <CampaignName>sample string 5</CampaignName>
    <Cost>7</Cost>
    <CreatedById>sample string 11</CreatedById>
    <CreatedDate>2025-05-13T14:09:24.1948896+00:00</CreatedDate>
    <Description>sample string 6</Description>
    <EmailId>sample string 17</EmailId>
    <FolderId>sample string 18</FolderId>
    <Id>sample string 3</Id>
    <InactiveMessage>sample string 16</InactiveMessage>
    <PortalCustomersId>sample string 2</PortalCustomersId>
    <PushCode>sample string 15</PushCode>
    <RevenuePerLead>8</RevenuePerLead>
    <Role>sample string 4</Role>
    <Status>sample string 9</Status>
    <Tags>sample string 10</Tags>
    <UpdatedById>sample string 13</UpdatedById>
    <UpdatedDate>2025-05-13T14:09:24.1948896+00:00</UpdatedDate>
  </Campaign>
  <Campaign>
    <CampaignId>sample string 1</CampaignId>
    <CampaignName>sample string 5</CampaignName>
    <Cost>7</Cost>
    <CreatedById>sample string 11</CreatedById>
    <CreatedDate>2025-05-13T14:09:24.1948896+00:00</CreatedDate>
    <Description>sample string 6</Description>
    <EmailId>sample string 17</EmailId>
    <FolderId>sample string 18</FolderId>
    <Id>sample string 3</Id>
    <InactiveMessage>sample string 16</InactiveMessage>
    <PortalCustomersId>sample string 2</PortalCustomersId>
    <PushCode>sample string 15</PushCode>
    <RevenuePerLead>8</RevenuePerLead>
    <Role>sample string 4</Role>
    <Status>sample string 9</Status>
    <Tags>sample string 10</Tags>
    <UpdatedById>sample string 13</UpdatedById>
    <UpdatedDate>2025-05-13T14:09:24.1948896+00:00</UpdatedDate>
  </Campaign>
</ArrayOfCampaign>