Delete

Deletes an object.

Syntax

            <Delete type="ObjectType"> 
   <ObjectType>
      <id>internalID</id> 
   </ObjectType>
</Delete> 

          

Usage

Use the Delete command to delete an object based with a specific internal ID. The maximum number of objects you can delete with one XML API call is 1,000.

Arguments

Name

Type

Description

ObjectType

Object

The object to be deleted. Object properties must include the object internal ID [id].

Response

  • Success if the object with internal ID id was found and deleted.

  • Failure if the object with internal ID id was not found.

  • A list of objects if the object with internal ID id was found but has dependencies. All dependent objects (objects referencing the ObjectType object by internal ID) must be deleted before you can delete the ObjectType object. Properties for the listed objects include only the internal ID [id].