Contacts
Contacts represent individual people within companies in your B2B platform. They are the actual contact persons and platform users associated with business entities (companies), enabling comprehensive user management and role-based access control within the organizational structure.
Overview
- Company Association: Each contact belongs to a parent company and inherits organizational settings and permissions
- User Management: Contacts serve as platform users with login credentials and role-based access control
- Personal Information: Comprehensive contact details including names, communication preferences, and demographic data
- Authentication & Access: Platform login capabilities with email-based authentication and user-specific permissions
- B2B Integration: Contacts can be synchronized with external CRM and ERP systems using source identifiers
- Role-Based Operations: Different contact types and roles within the company hierarchy for specialized access and functionality
Contact Lookup Keys
Contacts can be identified and referenced using multiple lookup keys for flexible integration scenarios:
| Lookup Key | Type | Description | Use Cases |
|---|---|---|---|
id | integer | Propeller contact ID (auto-generated) | Internal operations, direct API calls |
sourceId | string | External system unique identifier | CRM integration, data imports, bulk operations |
Note: When using sourceId, it must be combined with the source field to ensure uniqueness across different external systems.
Learn more: Understanding Lookup Keys
Contact Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Auto-generated | Unique Propeller contact identifier |
source | string | Optional* | External system name (*required when sourceId is provided) |
sourceId | string | Optional | External system unique identifier |
language | string | Optional | Default language (ISO 639-1) |
parent | object | Required | Parent company reference using id OR sourceId + source |
debtorId (deprecated) | string/integer | Optional | Deprecated. Identifier representing the contact's company in financial systems |
firstName | string | Optional | Contact first name |
middleName | string | Optional | Contact middle name/initials |
lastName | string | Optional | Contact last name |
abbreviation | string | Optional | Contact abbreviation/initials used in UI |
gender | enum (M, F, U) | Optional | Contact gender (M=Male, F=Female, U=Undefined) |
title | string | Optional | Contact title (e.g., Mr, Ms, Dr) |
email | string (email) | Optional | Contact email address |
login | string (email) | Optional | Login email address used for authentication |
phone | string | Optional | Contact phone number |
mobile | string | Optional | Contact mobile phone number |
dateOfBirth | string (date) | Optional | Contact date of birth (ISO 8601 date) |
primaryLanguage | string | Optional | Contact primary language (ISO 639-1) |
ssn | string | Optional | Social security number or national identifier |
mailingList | enum (Y,N) | Optional | Mailing list subscription preference |
Contact Errors
This section describes error codes specific for the Contact resource.
| Code | Error Type | Status Code | Message | Reason |
|---|---|---|---|---|
50004 | ContactExists | 400 | Contact already exists | Contact with such lookup key already exists |
50005 | ContactMultipleFound | 400 | Multiple contacts found. Please provide additional filters | Multiple contacts with such lookup key exist |
50006 | ContactNotFound | 404 | Contact does not exist | Contact with such lookup key not found |
50007 | ParentContactNotFound | 404 | Parent contact not found | Parent contact with such lookup key not found. This error is typical when working with contact sub-resources (e.g. attributes) |
50008 | ContactNotAllowed | 404 | Contact is not allowed | Usually when contact is in Recycle Bin and can't be used |