POST api/SocialCampaignItemPage/Adpreview?AdAccountID={AdAccountID}&MediaID={MediaID}&AdCampaignID={AdCampaignID}

Request Information

URI Parameters

Name	Type	Additional information
AdAccountID	integer	Required
MediaID	integer	Required
AdCampaignID	integer	Default value is 0

Body Parameters

SocialCampaignItemPage

Name	Type	Additional information
ID	integer	None.
PageID	string	Required
JobStatusID	integer	None.
JobStatus	JobStatus	None.
FirstRunDate	date	Data type: DateTime
LastRunDate	date	Data type: DateTime
LastError	string	None.
StatusID	string	String length: inclusive between 0 and 255
AlbumID	string	String length: inclusive between 0 and 255
permalink_url	string	String length: inclusive between 0 and 500
SocialFormID	string	String length: inclusive between 0 and 50
SocialOfferID	string	String length: inclusive between 0 and 50
AddContact	string	String length: inclusive between 0 and 10
AddContactSource	string	None.
MappingID	string	String length: inclusive between 0 and 10
SendEmail	string	String length: inclusive between 0 and 10
EmailLabel	string	String length: inclusive between 0 and 500
SendSMS	string	String length: inclusive between 0 and 10
SMSLabel	string	String length: inclusive between 0 and 500
AddLead	string	String length: inclusive between 0 and 500
LeadLabel	string	String length: inclusive between 0 and 500
GenerateOffer	string	String length: inclusive between 0 and 10
OfferLabel	string	String length: inclusive between 0 and 500
CreateCustomAudience	integer	None.
CustomAudienceName	string	String length: inclusive between 0 and 200
InstagramActorID	string	String length: inclusive between 0 and 100
LeadSource	integer	None.
LeadStatus	integer	None.
LeadCategory	integer	None.
LeadComment	string	None.
ProcessOldEmail	boolean	None.
ProcessOldSms	boolean	None.
ProcessOldLead	boolean	None.
ProcessOldCustomAudience	boolean	None.
SocialCampaignItemID	integer	None.
IsDeleted	boolean	None.
NbrCalls	integer	None.
IG_MobileApp	boolean	None.
IG_PublishType	string	None.
ModifiedBy	integer	None.
ModifiedByName	string	None.
Longitude	string	None.
Latitude	string	None.
IsGreater	boolean	None.
Temperature	decimal number	None.
Forecast	string	None.
ForecastDays	integer	None.
WeatherOperator	string	None.
IsNotficationSent	boolean	None.
LastNotifcationSendDate	date	None.
TaggedLocation	string	None.
TaggedLocationName	string	None.
TaggedLocationDesc	string	None.
comments_count	integer	None.
likes_count	integer	None.
shares_count	integer	None.
AudienceID	integer	None.
PageItemDynamicFields	Collection of SocialCampaignDynamicFieldItemPage	None.
PageItemAudience	SocialCampaignItemPageAudience	None.
SocialCampaignItem	SocialCampaignItem	None.
Page	Page	None.
CustomPage	SocialPage	None.
HasFirstComment	boolean	None.
SocialCampaignItemAttachmentPages	Collection of SocialCampaignItemAttachmentPage	None.
FirstCommentID	string	None.
FirstCommentStatus	integer	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AdPreview

Name	Type	Additional information
PageID	string	None.
PageName	string	None.
PreviewName	string	None.
SocialCampaignItemPageID	integer	None.
Previews	Collection of PreviewFormat	None.

Response Formats

application/json, text/json

Sample:

{
  "PageID": "sample string 1",
  "PageName": "sample string 2",
  "PreviewName": "sample string 3",
  "SocialCampaignItemPageID": 1,
  "Previews": [
    {
      "format": "sample string 1",
      "Preview": "sample string 2"
    },
    {
      "format": "sample string 1",
      "Preview": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AdPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SM.Data.Models.AdModel">
  <PageID>sample string 1</PageID>
  <PageName>sample string 2</PageName>
  <PreviewName>sample string 3</PreviewName>
  <Previews>
    <PreviewFormat>
      <Preview>sample string 2</Preview>
      <format>sample string 1</format>
    </PreviewFormat>
    <PreviewFormat>
      <Preview>sample string 2</Preview>
      <format>sample string 1</format>
    </PreviewFormat>
  </Previews>
  <SocialCampaignItemPageID>1</SocialCampaignItemPageID>
</AdPreview>