POST api/campaign/create

Creates a campaign. Note: This is for QA testing only. This is not available in Production

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

StubCampaignCreate
NameDescriptionTypeAdditional information
type

Denotes the type of Stub Campaign to create. Valid values are "search" and "display"

string

 

Request Formats

application/json, text/json

Sample:
{
  "type": "search"
}

application/xml, text/xml

Sample:
<StubController.StubCampaignCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Controllers">
  <type>search</type>
</StubController.StubCampaignCreate>

Response Information

Successful Response:

Resource Description

Campaign
NameDescriptionTypeAdditional information
id

The campaign Id. Used for any action taken on the campaign or its subscritption.

integer

 

name

The name by which the user knows the campaign

string

 

status

The current Campaign Status

string

 

type

The campaign type

string

 

landingUrl

Default landing Url for ads

string

 

Response Formats

application/json, text/json

Sample:
{
  "id": 111,
  "name": "My campaign",
  "status": "Active",
  "type": "Search",
  "landingUrl": "https://www.domain.com"
}

application/xml, text/xml

Sample:
<Campaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <id>111</id>
  <landingUrl>https://www.domain.com</landingUrl>
  <name>My campaign</name>
  <status>Active</status>
  <type>Search</type>
</Campaign>