Skip to main content

Contacts and contact groups

A contact represents a person in client information. A contact group brings related people and shared information together. Keep those identities separate when mapping MyCRM to another system.

Read the shape you need​

Retrieve one known contact, query the contacts collection, or follow a supported relationship from a contact group. Use include=contactAddress on a contact when address details are needed alongside it. Include support, writable fields and relationship mutability are defined per resource.

Validation beyond the schema​

The reviewed contact validator requires at least a first or last name when creating a contact. It validates names, titles, email addresses and phone formats when supplied. Date-of-birth validation applies to supplied values. A field being nullable in the schema does not remove conditional business rules.

PATCH only the attributes your integration owns. Do not copy a complete read response into a write: a response can include read-only fields and relationships.

Access and ownership​

Search requires appropriate search scopes. Known-ID reads have separate read requirements. Shared application records may be outside the API's organisation access. The adviser context is used for permitted writes and some searches.