Customer contacts
Person associated with a customer organization or branch.
- API name:
customercontacts - Domain: Parties
- Modules: Sales, Stores, Services, Finances, Logistics, Directory
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Customer | customerId | Reference | Yes | |
| First name | firstName | Text | Yes | |
| Middle name | middleName | Text | ||
| Paternal last name | paternalLastName | Text | Yes | |
| Maternal last name | maternalLastName | Text | ||
| Full name | fullName | Text | Yes | |
| Job title | title | Text | ||
| Branch | customerbranchId | Reference | ||
| Primary | isPrimary | Boolean | Yes | When enabled, this row is the main link among peers of the same kind. |
| Role | role | Constant | Contact function for this account. Leave empty when unknown, or choose General. | |
| Emails | emails | Email | Emails | ||
| Phones | phones | Phone | Phones | ||
| Links | links | Link | Links | ||
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Customer customerId | Customers | grouped by |
Branch customerbranchId | Customer branches | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event customercontacts.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new contact. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this contact. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this contact. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · CLI |
| Unblock | unblock | Allow edits and deletion of this contact again. | App · API · CLI |
| Archive | archive | Retire this contact from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this contact to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this contact and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |