POST api/service/create/campaign/quickstart

This endpoint has been sunsetted and is no longer supported. All requests will result in a 400 Bad Request response.

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

Service
NameDescriptionTypeAdditional information
type

The type of service to order for the given account.

 string

Required

A valid Service Type
referenceId

Optional reference Id tracked at the partner level. Used to avoid duplication of jobs.

 string

 
note

Optional notes about the job.

 string

Max length: 5000
currency

Currency in which the fee will be charged

 Currency

 
partnerSKU

Partner Sku (Create)

 

Request Formats

application/json, text/json

Sample: 
{
  "type": "QuickStart Campaign",
  "referenceId": "XYZ1234",
  "note": null,
  "currency": "Undefined",
  "partnerSKU": null
}

application/xml, text/xml

Sample: 
<Service xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.CreateModels">
  <currency>Undefined</currency>
  <note i:nil="true" />
  <partnerSKU i:nil="true" />
  <referenceId>XYZ1234</referenceId>
  <type>QuickStart Campaign</type>
</Service>

Response Information

Successful Response:

Resource Description

QuickStart Job
NameDescriptionTypeAdditional information
id

string

 
charge

Charge Detail

 

Response Formats

application/json, text/json

Sample: 
{
  "id": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
  "charge": null
}

application/xml, text/xml

Sample: 
<QuickStartJob xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <charge i:nil="true" />
  <id>aaaaaaaa-bbbb-cccc-dddd-111111111111</id>
</QuickStartJob>