AccountAlert

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.

This entity describes a configurable alert message, associated with an account, that appears on different account related pages. It can convey important details about the account, for example, special contract requirements, billing arrangements, or support needs. There are three types of account alerts. The type determines where the alert appears; for example, the Account Detail Alert type appears on the Account Detail page. Account Alerts are configured on the Alerts tab of the Edit Account page.

IMPORTANT  Key attributes of this entity have changed with the release of Autotask 2021.3. These changes may require updates to your existing integrations. To avoid service disruption, we recommend that you review your applications for compatibility with the updates described in the 2021.3 SOAP API revision history revision history.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: AccountAlert
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

General

  • This entity respects Account security level settings.
  • The API user must have an adequate security level to access the account and return alerts for it on query.
  • The API user may only create, update, and delete alerts for accounts to which they have edit access.
  • There can be only one instance of any AccountID/AlertTypeID combination.

Special field attributes

Field Conditions and Requirements
AccountID AccountID for an existing Alert Type cannot be changed.
AlertTypeID AlertTypeID for an existing Alert Type cannot be changed.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
AccountID {LT:Account} ID integer Account  
AlertText Alert Text string (8000)      
AlertTypeID Alert Type ID integer  
id Alert ID long