ContactGroupContact
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
This entity describes a Contact associated with a ContactGroup. Contact Groups are an association of contacts, from one or more companies, that allows PSA users to send bulk email, and create notes and/or to-dos, simultaneously for all included contacts.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
Entity Name: | ContactGroupContact |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
- Contacts can only be associated with, or removed from, an Active ContactGroup.
- A ContactID cannot be associated with the same ContactGroupID more that once.
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 |
---|---|---|---|---|---|---|
id | Contact Group ID | long | ||||
ContactGroupID | Contact Group ID | integer | ContactGroup | |||
ContactID | Contact ID | integer | Contact |