Follow

Update or Create External Advertisement

Updates or creates an external advertisement. The advertisement is required to have an external identifier. If there is already an advertisement with matching ID and the system type, the existing advertisement is updated with the information given. Otherwise, a new instance of the advertisement is created.

 

Attributes

Attribute

Value

Path

/v3/organisations/{OrganisationID}/externalAdvertisements

Support Formats

JSON, XML

HTTP Method

POST

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        201 - Created

·        400 - Bad Request

·        500 - Internal Server Error

 

Request

The following table contains the details of a typical HTTP request for this service:

Type

Value

Header

POST /v3/organisations/123/externalAdvertisements HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Body

{

   "id":"1568-001",

   "systemType":"10",

   "advertisementStatus":1,

   "title":"ACME products",

   "contentUrl":"http://www.acme.co.nz",

   "campaignId":1,

   "description":"Great news!....",

   "startDate":"2014-03-28T00:00:00Z",

   "endDate":"2014-08-17T23:59:59Z",

   "NoCompeteGroup":"1568",

   "contentTagReferenceCodes":["88"],

   "venueExternalIds":[],

   "unlimitedBudget":"true",

   "maxBudget":"",

   "extendedData":"Custom JSON data goes here.",

   "placementCode":"FS",

   "channelCode":"MA",

   "weight":100

}

Note:

  • Campaign ID must be a valid campaign that belongs to the owner organisation (specified by the URL).
  • advertisementStatus values can be one of 0 (Draft), 1 (Published), 2 (Archived)

 

Response

Type

Value

Header

HTTP/1.1 201 CREATED

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.