Requirements for version 1.6+

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. Access to version 1.6 will deactivate in Q4 2024. Visit our SOAP API lifecycle FAQ article to learn more.

Version 1.6 of the Autotask SOAP API is a major revision from previous versions of the platform. To ensure the best service and performance, version 1.6.0 includes new requirements, and sound development processes are more important than ever.

This version of the API introduces the following significant changes.

Impersonation SOAP XML Example

Integration users need to provide the <ImpersonateAsResourceID> tag in the AutotaskIntegrations SOAP header. This examples creates a ticket note on behalf of another user account.

 <?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>[substitute Tracking Identifier here]</IntegrationCode>
      <ImpersonateAsResourceID>[substitute ID of RESOURCE TO IMPERSONATE here]</ImpersonateAsResourceID>
    </AutotaskIntegrations>
  </soap:Header>
  <soap:Body>
    <create xmlns="http://autotask.net/ATWS/v1_6/">
      <Entities>
        <Entity xsi:type="TicketNote" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <Description>Note Description</Description>
          <NoteType>3</NoteType>
          <Publish>1</Publish>
          <TicketID>14072</TicketID>
          <Title>Note Title</Title>
        </Entity>
      </Entities>
    </create>
  </soap:Body>
</soap:Envelope>

NOTE  The Web Services API does not support single sign on (SSO). If you are using SSO with Autotask, the API will recognize your Autotask credentials used prior to SSO. The password will not expire.