Understanding contacts
Core purpose
Contacts provide a structured way to manage relationships with individuals within customer organizations. Each contact can have specific roles, responsibilities, and preferences that help in personalizing interactions.
Contact roles
Primary roles
• Primary contact: Main decision maker
• Billing contact: Financial matters
• Technical contact: Implementation and support
• Executive sponsor: Strategic relationship
• Billing contact: Financial matters
• Technical contact: Implementation and support
• Executive sponsor: Strategic relationship
Supporting roles
• Department heads
• Team managers
• Project leads
• Subject matter experts
• Team managers
• Project leads
• Subject matter experts
Standard fields
Required fields
Name | Type | Options | Comments |
---|---|---|---|
Organization ID | string | Required | Organization the contact belongs to |
First Name | string | Required | Contact’s first name |
string | Required, Unique per organization | Primary email address | |
Contact Type | string | Required, Values: [PRIMARY (default), BILLING, LEGAL, EXECUTIVE, OTHER] | Type of contact relationship |
Is Marketing Contact | boolean | Required, Default: false | Marketing communication preference |
Is Active | boolean | Required, Default: true | Contact’s active status |
Optional fields
Name | Type | Options | Comments |
---|---|---|---|
Last Name | string | Optional | Contact’s last name |
Phone Number | string | Optional | Phone number with country code |
Avatar URL | string | Optional | Profile picture URL |
Metadata | jsonb | Optional | Additional metadata |
Customer User ID | string | Optional, Unique | Associated user reference |
System-managed fields
Name | Type | Options | Comments |
---|---|---|---|
Contact ID | bigserial | Auto-generated | Primary key |
UID | text | Auto-generated | Unique identifier (ULID) |
Created At | timestamp | Auto-populated | Creation timestamp with timezone |
Updated At | timestamp | Auto-populated | Last update timestamp with timezone |
Deleted At | timestamp | Optional | Soft delete timestamp with timezone |
Database types:
- Organization ID and Customer User ID are stored as
bigint
in the database - First Name, Last Name, Email, Phone Number are stored as
text
- Metadata is stored as
jsonb
- System fields use their respective database types (
bigserial
,text
,boolean
,timestamp with time zone
)
Best practices
1
Contact information management
- Maintain up-to-date contact details
- Verify email addresses periodically
- Document communication preferences
- Track role changes
2
Role assignment
- Clearly define primary contacts
- Maintain backup contacts
- Document role transitions
- Update access permissions
3
Communication
- Respect time zones
- Follow language preferences
- Maintain communication history
- Track engagement levels
API endpoints
Sample contact
When creating a contact, the system will add additional fields in the response such as
uid
, createdAt
, updatedAt
, and accountId
.Available operations
Contact management
Contact management
All endpoints require authentication with Bearer token, API key, and Organization ID in the headers.