delete

Deletes extensions.

Learn more

Restrictions

Maximum of 10,000 extensions per method call.

If an extension is assigned to an ad, you can't delete it. First you must unassign the extension from all ads.

Request

Request structure in JSON format:

{
  "method": "delete",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */
    } /* required */
  }
}

Parameter

Type

Description

Required

params structure (for JSON) / DeleteRequest structure (for SOAP)

SelectionCriteria

IdsCriteria

Criteria for selecting extensions to delete.

Yes

IdsCriteria structure

Ids

array of long

IDs of extensions to be deleted (maximum of 10,000).

Yes

Response

Response structure in JSON format:

{
  "result": {  /* result */
    "DeleteResults": [{  /* ActionResult */
      "Id": (long),
      "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 ActionResult

Results of deleting extensions.

ActionResult structure

Id

long

ID of the deleted extension. 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.

Previous
Next