POST api/CampaignFromLibrary

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignName	string	None.
AssetType	string	None.
AssetName	string	None.
Location	string	None.
AssetId	string	None.
AssetUrlId	string	None.
WebLink	string	None.
PDFName	string	None.
EmailAddress	string	None.
Notifications	string	None.
EmailClientVersion	string	None.
EmailClient	string	None.
ExternalEmailId	string	None.
Subject	string	None.
AllowDownload	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignName": "sample string 1",
  "AssetType": "sample string 2",
  "AssetName": "sample string 3",
  "Location": "sample string 4",
  "AssetId": "sample string 5",
  "AssetUrlId": "sample string 6",
  "WebLink": "sample string 7",
  "PDFName": "sample string 8",
  "EmailAddress": "sample string 9",
  "Notifications": "sample string 10",
  "EmailClientVersion": "sample string 11",
  "EmailClient": "sample string 12",
  "ExternalEmailId": "sample string 13",
  "Subject": "sample string 14",
  "AllowDownload": "sample string 15"
}

application/xml, text/xml

Sample:

<QuickCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <AllowDownload>sample string 15</AllowDownload>
  <AssetId>sample string 5</AssetId>
  <AssetName>sample string 3</AssetName>
  <AssetType>sample string 2</AssetType>
  <AssetUrlId>sample string 6</AssetUrlId>
  <CampaignName>sample string 1</CampaignName>
  <EmailAddress>sample string 9</EmailAddress>
  <EmailClient>sample string 12</EmailClient>
  <EmailClientVersion>sample string 11</EmailClientVersion>
  <ExternalEmailId>sample string 13</ExternalEmailId>
  <Location>sample string 4</Location>
  <Notifications>sample string 10</Notifications>
  <PDFName>sample string 8</PDFName>
  <Subject>sample string 14</Subject>
  <WebLink>sample string 7</WebLink>
</QuickCampaign>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseService

Name	Type	Additional information
validRequest	boolean	None.
RequestMessage	string	None.
EntityName	string	None.
EntityId	string	None.
URL	string	None.
APIVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "validRequest": true,
  "RequestMessage": "sample string 2",
  "EntityName": "sample string 3",
  "EntityId": "sample string 4",
  "URL": "sample string 5",
  "APIVersion": "sample string 6"
}

application/xml, text/xml

Sample:

<ResponseService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <APIVersion>sample string 6</APIVersion>
  <EntityId>sample string 4</EntityId>
  <EntityName>sample string 3</EntityName>
  <RequestMessage>sample string 2</RequestMessage>
  <URL>sample string 5</URL>
  <validRequest>true</validRequest>
</ResponseService>