Domain Model
Contact
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| organizationId | string | Yes | — | ID of the associated organization |
| firstName | string | Yes | — | First name |
| lastName | string | Yes | — | Last name |
| title | string | No | — | Title |
string.email | No | — | ||
| phone | string | No | — | Phone |
| mobile | string | No | — | Mobile |
| roleTags | string[] | Yes | — | Role tags |
| preferredContactMethod | enum(email, phone, mobile, portal) | No | — | Preferred contact method |
| portalAccessStatus | enum(none, invited, active, suspended) | Yes | — | Portal access status |
| status | enum(active, inactive) | Yes | — | Status |
| notesSummary | string | No | — | Notes summary |
| isPrimary | boolean | Yes | — | Is primary |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| organizationId | string | Yes | — | ID of the associated organization |
| firstName | string | Yes | — | First name |
| lastName | string | Yes | — | Last name |
| title | string,null | No | — | Title |
unknown | No | — | ||
| phone | string,null | No | — | Phone |
| mobile | string,null | No | — | Mobile |
| roleTags | string[] | Yes | [] | Role tags |
| preferredContactMethod | enum(email, phone, mobile, portal) | No | — | Preferred contact method |
| portalAccessStatus | enum(none, invited, active, suspended) | Yes | "none" | Portal access status |
| status | enum(active, inactive) | Yes | "active" | Status |
| notesSummary | string,null | No | — | Notes summary |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| organizationId | string | No | — | ID of the associated organization |
| firstName | string | No | — | First name |
| lastName | string | No | — | Last name |
| title | string,null | No | — | Title |
unknown | No | — | ||
| phone | string,null | No | — | Phone |
| mobile | string,null | No | — | Mobile |
| roleTags | string[] | No | — | Role tags |
| preferredContactMethod | enum(email, phone, mobile, portal) | No | — | Preferred contact method |
| portalAccessStatus | enum(none, invited, active, suspended) | No | — | Portal access status |
| status | enum(active, inactive) | No | — | Status |
| notesSummary | string,null | No | — | Notes summary |