ContactGroupContacts
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.
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: | ContactGroupContacts |
|
Entity Path: |
/atservicesrest/v1.0/ContactGroupContacts |
| Can Create: |
|
| Can Update: | |
| Can Query: |
|
| Can Delete: |
|
| Can Have UDFs: |
Conditions and requirements
- Contacts can only be associated with, or removed from, an isActive ContactGroup.
- A contactID cannot be associated with the same contactGroupId more that once.
Field definitions
About this table
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 |
|---|---|---|---|---|---|
| contactGroupId | integer |
|
ContactGroups | ||
| contactID | integer |
|
Contacts | ||
| id | long |
|
|
