CompanyAlerts

This entity describes a configurable alert message, associated with a company, that appears on different company-related pages. It can convey important details about the company, such as special contract requirements, billing arrangements, or support needs. There are three types of company alerts. The type determines where the alert appears; for example, the Company Detail Alert type appears on the Company Detail page. Company Alerts are configured on the Alerts tab of the Edit Company 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 REST API revision history revision history.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: CompanyAlerts

Entity Path:

/atservicesrest/v1.0/CompanyAlerts
Entity Name: Companies
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

General

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

Special field attributes

Field Conditions and Requirements
alertTypeID alertTypeID for an existing Alert Type cannot be changed.
companyID companyID for an existing Alert Type cannot be changed.

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
alertText string (8000)      
alertTypeID integer  
companyID integer Companies  
id long    

Additional resources