Contacts
The Contacts entity describes an individual associated with a Company. Autotask users manage contacts through the CRM module (CRM > Contacts).
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: | Contacts |
Entity Path: |
/atservicesrest/v1.0/Contacts |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: | |
Supports webhooks: |
Fields that cannot be queried
Although you can query this entity, it contains one or more fields that are not queryable. If you attempt to query these fields, you will receive an error message.
- isOptedOutFromBulkEmail
- solicitationOptOut
- surveyOptOut
Conditions and requirements
General
- Create actions require security level permission to add Contacts.
- The Contact entity can have no more than 100 UDFs. Refer to UserDefinedFieldDefinitions.
- Contacts cannot be deleted if any of the following conditions apply:
- The contact is the primary or a secondary contact on a task or ticket
- The contact is selected as an invoice email recipient
- The contact has created tickets or ticket notes in the Client Portal
- The contact is a Taskfire Administrator or a Taskfire Resource
- The contact is the Installed By contact for any asset (via Client Portal/Taskfire)
- The contact has created or modified knowledge base articles
- The contact is the Primary Contact or Outsource Contact for the company
- The contact has received outsourcing invitations
- The contact is associated with outsourcing tickets
Special field attributes
Field | Conditions and Requirements |
---|---|
bulkEmailOptOutTime | bulkEmailOptOutTime indicates the date that the contact opted out. The CAN-SPAM act specifies 30 days as the minimum time to refrain from sending commercial emails to recipients that have chosen to opt out of bulk email. Since there may be a need to communicate technical or product information to users who have opted out of bulk email, Autotask does not force compliance with the 30 day opt out period. |
companylocationID | On update, if the addressLine, addressLine1, city, state, ZipCode, and countryID fields are blank and then a companylocationID is provided, addressLine, addressLine1, city, state, ZipCode, and countryID fields are populated with data from the corresponding fields from companylocationID. If any of the following fields contain data, Address 1, Address 2, City, State, Zip Code, or Country when companylocationID is provided, none of the fields are updated. |
Email address character limit | The REST API enforces a limit of 254 characters for contact email addresses (EmailAddress, emailAddress2, and emailAddress3). |
emailAddress2 and emailAddress3 | emailAddress2 and emailAddress3 are for use with Autotask Incoming Email Processing. |
isOptedOutFromBulkEmail | The isOptedOutFromBulkEmail field indicates whether or not this contact has opted out of receiving bulk emails generated by Autotask. |
note | This field does not appear on the contact entity. It cannot be edited in the main UI. It can only be updated by the API. It can be viewed by customizing the Contact Insight where it appears on an entity category and adding the Notes field. |
primaryContact | A Company (companyID) can have only one Primary Contact. If a Contact entity is made primaryContact for a Company, and that Company is associated with another Contact entity that is already set as primaryContact for the Company, then the existing (older) Contact entity will be updated to set primaryContact to false. |
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:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
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 | Webhook field |
---|---|---|---|---|---|---|
additionalAddressInformation | string (100) | |||||
addressLine | string (128) | |||||
addressLine1 | string (128) | |||||
alternatePhone | string (32) | |||||
apiVendorID | integer | |||||
bulkEmailOptOutTime | datetime | |||||
city | string (32) | |||||
companyID | integer | Companies | ||||
companylocationID | integer | CompanyLocations | ||||
countryID | integer | Countries | ||||
createDate |
datetime |
|
|
|
|
|
emailAddress | string (50) | |||||
emailAddress2 | string (50 | |||||
emailAddress3 | string (50 | |||||
extension | string (10) | |||||
externalID | string (50) | |||||
facebookUrl | string (200) | |||||
faxNumber | string (25) | |||||
firstName | string (20) | |||||
id | long | |||||
impersonatorCreatorResourceID | integer | Resources | ||||
isActive | integer | |||||
isOptedOutFromBulkEmail | boolean | |||||
lastActivityDate | datetime | |||||
lastModifiedDate | datetime | |||||
lastName | string (20) | |||||
linkedInUrl | string (200) | |||||
middleInitial | string (50) | |||||
mobilePhone | string (25) | |||||
namePrefix | integer | |||||
nameSuffix | integer | |||||
note | string (50) | |||||
phone | string (25) | |||||
primaryContact | boolean | |||||
receivesEmailNotifications | boolean | |||||
roomNumber | string (50) | |||||
solicitationOptOut | boolean | |||||
solicitationOptOutTime | datetime | |||||
startDate | datetime | |||||
state | string (40) | |||||
surveyOptOut | boolean | |||||
title | string (50) | |||||
twitterUrl | string (200) | |||||
zipCode | string (16) |