Table of Contents
The Person Object provides a data structure for managing contacts and individuals.
Module: Contacts
Collection: People
Object Identifier: contacts.person
Data Fields #
| Field Name | API Field Name | Data Type | Description | Optimised for Filters |
|---|---|---|---|---|
| UUID | uuid | UUID | Universally Unique Identifier for each contact person. | Yes |
| Application UUID | app_uuid | UUID | IIdentifier for the associated application. This is what links the object in your account to your specific application. | Yes |
| Application Context Ref | app_context_ref | Text (max length 50) | You can use this field to provide searchable context to your object – for example this may be an external identifier, or a lookup UUID to another object in your application. | Yes |
| Sub UUID | sub_uuid | UUID | Similar to the Application Context Ref, This field can be used to store a UUID to another Object. | Yes |
| Linked Org UUID | linked_contact_org_uuid | UUID | Identifier for an organisation Object in the contacts.org Collection. The Organisation Object must already exist in that Collection, otherwise an error will occur when creating the new Object. | Yes |
| Contact Type | contact_type | Enumerated List | Type of contact (e.g., customer, lead, partner). Allowable values are:agent, customer, lead, partner, subscriber,supplier, other, user, <empty-string> | Yes |
| Title | title | Text (max length 10) | Title of the contact person (e.g., Mr, Mrs) | No |
| First Name | first_name | Text (max length 50) | First name of the contact person. | Yes |
| Middle Name | middle_name | Text (max length 50) | Middle name of the contact person. | No |
| Last Name | last_name | Text (max length 50) | Last name of the contact person. | Yes |
email | Text (max length 100) | Email address of the contact person. | Yes | |
| Phone | phone | Text (max length 20) | Phone number of the contact person. | Yes |
| Mobile | mobile | Text (max length 20) | Mobile number of the contact person. | Yes |
| Address Line 1 | addr_line1 | Text (max length 50) | First line of the contact’s address. | No |
| Address Line 2 | addr_line2 | Text (max length 50) | Second line of the contact’s address. | No |
| Address Line 3 | addr_line3 | Text (max length 50) | Third line of the contact’s address. | No |
| Address Line 4 | addr_line4 | Text (max length 50) | Fourth line of the contact’s address. | No |
| City | city | Text (max length 50) | City / town in the contact’s address. | No |
| County | county | Text (max length 50) | County / state in the contact’s address. | No |
| Postcode | postcode | Text (max length 10) | Postal / Zip code in the contact’s address. | Yes |
| Country Code | country_code | Text (max length 3) | ISO 3-digit country code of the contact. | Yes |
| Date of Birth | dob | Date | Date of birth of the contact person. | No |
| Notes | notes | Memo | Additional notes about the contact person. | No |
| Status | status | Enumerated List | Status of the contact person (e.g., active, inactive). Allowable values are:'active', 'inactive', 'archived', 'test','other', <empty-string> | No |
| Position | position | Text (max length 50) | Position or role of the contact person. | No |
| Person Taxonomy | person_taxonomy | Text (max length 50) | Categorisation of the person (default: 'person' ). | Yes |
| Created At | created_at | DateTime | Timestamp when the record was created. | No |
| Updated At | updated_at | DateTime | Timestamp when the record was last updated | No |
| Created By | created_by | Text (max length 50) | You can use this field to record who or what created the Object record. | No |
| Updated By | updated_by | Text (max length 50) | You can use this field to record who or what last updated the Object record. | No |