delete()
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.
Use the delete() API call to remove objects in the Autotask system. Not all entities accept the delete() call. To find out if an entity accepts delete(), use the The getEntityInfo() SOAP API call call.
Considerations
The following considerations apply to this Web Services call.
Permissions | By default, the API User (system) (API-only) security level grants Full access permissions, but copies of this security level may have been modified. The API user must have access to the appropriate Autotask module for the entity type and sufficient rights to perform the specified API call. |
id | The id is auto-generated by Autotask and uniquely identifies a particular entity instance. Use this value to identify the target record when using the delete() API call. Use query() to determine the id for an entity. |
Update/Create/Delete Maximum Entities | The Web Service API calls can update, create or delete a maximum of 200 objects with one call. If you send more than 200 elements in your array, the call will fail and no changes will occur in Autotask. |
Sample delete() SOAP XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AutotaskIntegrations xmlns="http://autotask.net/ATWS/v1_6/">
<IntegrationCode>[insert your own tracking identifier]</IntegrationCode>
</AutotaskIntegrations>
</soap:Header>
<soap:Body>
<delete xmlns="http://autotask.net/ATWS/v1_6/">
<Entities>
<Entity xsi:type="AccountTeam" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>107</id>
</Entity>
</Entities>
</delete>
</soap:Body>
</soap:Envelope>