delete

Deletes images.

  1. Restrictions
  2. Request
  3. Response

Restrictions

Maximum of 10,000 images per method call.

If an image is assigned to an ad, it can't be deleted.

Request

Request structure in JSON format:

{
  "method": "delete",
  "params": {
    "SelectionCriteria": {  /* AdImageIdsCriteria */
      "AdImageHashes": [(string), ... ]
    } /* required */
  }
}
Parameter Type Description Required
Params structure (for JSON) / DeleteRequest structure (for SOAP)
SelectionCriteria AdImageIdsCriteria Criteria for selecting images to delete. Yes
AdImageIdsCriteria structure
AdImageHashes array of string

Hashes of images to delete (maximum of 10,000).

Yes

Response

Response structure in JSON format:

{
  "result": {  /* result */
    "DeleteResults": [{  /* AdImageActionResult */
      "AdImageHash": (string),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ] 
    }, ... ] /* required */
  }
}
Parameter Type Description
Result structure (for JSON) / DeleteResponse structure (for SOAP)
DeleteResults array of AdImageActionResult Results of deleting images.
AdImageActionResult structure
AdImageHash string

Hash of the deleted image. Returned if there aren't any errors. See the section Operations on object arrays.

Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification

Errors that occurred during the operation.