Skip to main content

ProductCRMIntegrationRead

Binds a product to a company CRM integration, with the mapping configuration used to import and sync that product's leads. Identified by the (product_id, crm_integration_id) pair. Tracks the last import and last sync times.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

crm_integration_idCrm Integration Idrequired

ID of the company CRM integration this binding connects the product to.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

last_import_at objectrequired

When leads were last imported from the CRM for this product (UTC).

anyOf
date-time
last_sync_at objectrequired

When this product's data was last synced to the CRM (UTC).

anyOf
date-time
config objectrequired

Per-product CRM mapping configuration (stage mapping, field mapping, sync options).

import_enabledImport Enabled
Default value: true
import_to_stage_id object
anyOf
integer
import_interval_secondsImport Interval Seconds
Default value: 86400
contacts_from_custom_fields object
property name* ProductCRMIntegrationContactFromCustomFieldConfig

Defines how one CRM custom field is imported as a contact.

guess_contact_typeGuess Contact Type
Default value: true
contact_type object
anyOf
ContactType

Possible values: [phone, username, chat_id, email]

channel_type object
anyOf
string

Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

ext_channel_id object
anyOf
string
channel_vendor object
anyOf
string

Possible values: [wazzup24, self_wz, chatpush, greenapi, wappi, chatapp, yandex_messenger, salebot, bothelp, radist, fasttrack, usedesk, amocrm_salesbot, bitrix24_openlines, twilio, mail.ru, gmail, pinbox, unipile, voice]

channel_alias object

Optional exact name of another CRM field whose value selects the product channel for this chat-id contact. Supported only for chat_id contacts and mutually exclusive with ext_channel_id.

anyOf
string
enum_fields object
property name* ProductCRMIntegrationEnumFieldConfig
typeTyperequired

Possible values: [select, multiselect]

optionsstring[]
crm_fields object
property name* ProductCRMIntegrationFieldConfig
crm_code object
anyOf
string
field_typeField Type
Default value: text
sourceSource

Possible values: [custom, system]

Default value: custom
is_multipleIs Multiple
Default value: false
import_enabledImport Enabled
Default value: false
is_read_onlyIs Read Only
Default value: false
options object[]
  • Array [
    • labelLabelrequired
    valueValuerequired
  • ]
    • contact_duplicates_allowedContact Duplicates Allowed
    Default value: false
    derive_phone_number_from_lead_titleDerive Phone Number From Lead Title
    Default value: true
    allow_empty_amocrm_salesbot_contactsAllow Empty Amocrm Salesbot Contacts

    When enabled for amoCRM Salesbot imports, contacts with no phone, email, username, or chat id are imported as Salesbot-only placeholder chat_id contacts keyed by the amoCRM contact id.

    Default value: false
    allow_empty_bitrix24_openlines_contactsAllow Empty Bitrix24 Openlines Contacts

    When enabled for Bitrix24 imports, CRM entities without ordinary contact details are imported with a synthetic chat_id contact so outbound messaging can reuse an active Open Lines chat.

    Default value: false
    sync_enabledSync Enabled
    Default value: false
    sync_interval_secondsSync Interval Seconds
    Default value: 86400
    deactivate_on_external_moveDeactivate On External Move
    Default value: false
    merged_lead_stage_id object

    Stage that leads are moved to when their CRM deal is merged into another one (see POST /leads/crm-merge). The stage must belong to this product. Leave unset to deactivate and mute merged-away leads without changing their stage. The move is local only and is never pushed back to the CRM.

    anyOf
    integer
    classification_fields_resync_requested_at object
    anyOf
    date-time
    classification_fields_last_resynced_at object
    anyOf
    date-time
    classification_fields_last_resync_failed_at object
    anyOf
    date-time
    classification_fields_last_resync_failures_countClassification Fields Last Resync Failures Count
    Default value: 0
    dump_message_enabledDump Message Enabled
    Default value: true
    dump_manager_messages_enabledDump Manager Messages Enabled
    Default value: true
    pipelines object[]
  • Array [
    • is_activeIs Active
    Default value: true
    pipeline_idPipeline Id
    Default value:
    stages object
    property name* ProductCRMIntegrationStageConfig
    crm_idCrm Idrequired

    Identifier of the matching record in the connected external CRM, if any.

    is_import_stageIs Import Stage
    Default value: false
  • ]
    • ProductCRMIntegrationRead
    {
      "product_id": 0,
      "crm_integration_id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "last_import_at": "2024-07-29T15:51:28.071Z",
      "last_sync_at": "2024-07-29T15:51:28.071Z",
      "config": {
        "import_enabled": true,
        "import_to_stage_id": 0,
        "import_interval_seconds": 86400,
        "contacts_from_custom_fields": {},
        "enum_fields": {},
        "crm_fields": {},
        "contact_duplicates_allowed": false,
        "derive_phone_number_from_lead_title": true,
        "allow_empty_amocrm_salesbot_contacts": false,
        "allow_empty_bitrix24_openlines_contacts": false,
        "sync_enabled": false,
        "sync_interval_seconds": 86400,
        "deactivate_on_external_move": false,
        "merged_lead_stage_id": 0,
        "classification_fields_resync_requested_at": "2024-07-29T15:51:28.071Z",
        "classification_fields_last_resynced_at": "2024-07-29T15:51:28.071Z",
        "classification_fields_last_resync_failed_at": "2024-07-29T15:51:28.071Z",
        "classification_fields_last_resync_failures_count": 0,
        "dump_message_enabled": true,
        "dump_manager_messages_enabled": true,
        "pipelines": [
          {
            "is_active": true,
            "pipeline_id": "",
            "stages": {}
          }
        ]
      }
    }