fluentcrm-companies-model

FluentCRM: Companies model and contact-company relations

Use this skill when a plugin needs to sync B2B account/company records into FluentCRM or attach contacts to existing companies. Companies are core FluentCRM 3.1.13 code, but the UI/automation surface is behind the experimental company_module setting.

Guard the feature

For UI, automation actions, or user-visible sync flows, check the module flag:

use FluentCrm\App\Services\Helper;

if (!function_exists('FluentCrmApi') || !Helper::isCompanyEnabled()) {
    return;
}

Helper::isCompanyEnabled() reads _fluentcrm_experimental_settings['company_module'] === 'yes'. The low-level API does not hard-block writes when the flag is off, so do not create surprise company data from a hidden integration unless the admin opted in.

API entry points

app/Api/config.php registers the API key as companies:

$companiesApi = FluentCrmApi('companies');

Create or update a company:

$company = FluentCrmApi('companies')->createOrUpdate([
    'name'        => sanitize_text_field($accountName),
    'email'       => sanitize_email($billingEmail),
    'website'     => esc_url_raw($website),
    'type'        => 'Customer',
    'industry'    => sanitize_text_field($industry),
    'owner_id'    => (int) $fluentContactId, // Subscriber ID, not WP user ID
    'custom_values' => [
        'external_account_id' => sanitize_text_field($externalId),
    ],
]);

Important behavior from Companies::createOrUpdate():

• Existing company lookup is by id when provided, otherwise by exact name.
• owner_id is a FluentCRM Subscriber ID. It is not a WordPress user ID.
• Setting owner_id attaches that contact to the company and sets the contact's primary company_id if empty.
• custom_values are formatted by CustomCompanyField and stored under serialized Company.meta['custom_values'].
• Create fires fluent_crm/company_created; update fires fluent_crm/company_updated.

Do not call FluentCrmApi('companies')->getCompany($name) for name lookup. The method name says $idOrName, but the 3.1.13 source checks id for numeric values and email for strings. For name lookup use: