ContactGroups

This entity describes 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: ContactGroups

Entity Path:

/atservicesrest/v1.0/ContactGroups

Parent Entity:

Contacts

Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Conditions and requirements

Special field attributes

Field Conditions and Requirements
isActive An inactive ContactGroup cannot have contact associations added or removed.
name ContactGroup.name must be unique.

Field definitions

Field Name Datatype Read-Only Is Required Reference Name Picklist
id long    
isActive boolean      
name string (100)      

Additional resources