Version 5.0
AdvertServe User Manual :: v5.0

Zones :: Delete API Module

Delete

Description

Allows you to move an existing zone into the recycle bin.

Module URI

Hyperlink /servlet/control/api/zones/delete

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)
idIntegerYes123 Must be the ID# of an existing zone

XML Response

Hyperlink /servlet/control/api/zones/delete?secret=(key)&id=123


<success/>

JSON Response

Hyperlink /servlet/control/api/zones/delete?secret=(key)&output=json&id=123


{ "success" : true }