Version 5.0
AdvertServe User Manual :: v5.0

Advertisers :: Recycle API Module

Recycle

Description

Allows you to either purge or restore an existing advertiser from the recycle bin. Be very careful! Once an advertiser has been purged from the recycle bin it cannot be restored!

Module URI

Hyperlink /servlet/control/api/advertisers/recycle

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
outputStringNoxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
actionStringYespurge Must be a String equal to one of the following values:
  • purge
  • restore
idIntegerYes123 Must be the ID# of an existing advertiser

XML Response

Hyperlink /servlet/control/api/advertisers/recycle?secret=(key)&action=purge&id=123


<success/>

JSON Response

Hyperlink /servlet/control/api/advertisers/recycle?secret=(key)&output=json&action=purge&id=123


{ "success" : true }