CRMIntegrationCreate

A company-level connection to an external CRM (amoCRM, Kommo, Bitrix24, FastTrack, Usedesk, or Google Sheets). OAuth-based CRMs are connected via their connect flow; Google Sheets is created through the dedicated endpoint. The safe form omits secrets.

company_idCompany Idrequired

ID of the owning company (the top-level tenant account).

name object

Optional human-readable integration name.

anyOf

• string
• null

string

crm_typeCrm Typerequired

The CRM system — amocrm, kommo, bitrix24, fasttrack, usedesk, or google_sheets.

Possible values: [amocrm, bitrix24, fasttrack, kommo, usedesk, google_sheets]

is_activeIs Active

Whether the integration is active.

Default value: true

webhook_uuid object

anyOf

• string
• null

string

config objectrequired

Non-secret CRM configuration (e.g. pipeline mapping, rate limits).

lead_modeLead Mode

Possible values: [lead, deal]

Default value: deal

google_sheets object

anyOf

• GoogleSheetsConfig
• null

sheet_url object

anyOf

• string
• null

string

sheet_name object

anyOf

• string
• null

string

pipeline_idPipeline Id

Default value: google_sheets_pipeline

mapping object

crm_id_column object

anyOf

• string
• null

string

name_column object

anyOf

• string
• null

string

contact_column object

anyOf

• string
• null

string

contact_type_column object

anyOf

• ContactType
• null

ContactType

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

contact_platform_column object

anyOf

• string
• null

string

contact_type_defaultContactType

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

Default value: phone

contact_platform_default object

anyOf

• string
• null

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]

stage_columnStage Column

Default value: stage

crm_fields_columnsstring[]

document_columnsstring[]

dialogue_history_column object

anyOf

• string
• null

string

crm_fields_dump_column object

anyOf

• string
• null

string

summary_column object

anyOf

• string
• null

string

rate_limit_requestsRate Limit Requests

Default value: 7

rate_limit_periodRate Limit Period

Default value: 1

responsible_whitelist_enabledResponsible Whitelist Enabled

Default value: false

responsible_whiteliststring[]

crm_id_whiteliststring[]

crm_id_whitelist_enabledCrm Id Whitelist Enabled

Default value: false

skip_if_multiple_recent_ticketsSkip If Multiple Recent Tickets

Default value: false

skip_if_multiple_recent_tickets_threshold_hoursSkip If Multiple Recent Tickets Threshold Hours

Default value: 72

secrets objectrequired

client_idClient Idrequired

client_secretClient Secretrequired

redirect_uri object

anyOf

• string
• null

string

service_account_json object

anyOf

• object
• null

object

tokens object

anyOf

• CRMIntegrationTokens
• null

access_tokenAccess Tokenrequired

refresh_tokenRefresh Tokenrequired

account_idAccount Id

Default value:

token_typeToken Type

Default value:

expires_atdate-timerequired

refererReferer

Default value:

application_token object

anyOf

• string
• null

string

versionVersion

Possible values: [v1, v2]

Default value: v1

amojo_id object

anyOf

• string
• null

string

chat_scope_id object

anyOf

• string
• null

string

chat_channel_id object

anyOf

• string
• null

string

chat_bot_id object

anyOf

• string
• null

string

chat_client_secret object

anyOf

• string
• null

string

agent_id object

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

anyOf

• string
• null

string

amocrm_salesbot_bot_id object

anyOf

• integer
• null

integer

bitrix24_openlines_bot_id object

ID of the Open Lines bot provisioned by the explicit Open Line configuration endpoint. Clients should not set or change it.

anyOf

• integer
• null

integer

CRMIntegrationCreate

{
  "company_id": 0,
  "name": "string",
  "crm_type": "amocrm",
  "is_active": true,
  "webhook_uuid": "string",
  "config": {
    "lead_mode": "deal",
    "google_sheets": {
      "sheet_url": "string",
      "sheet_name": "string",
      "pipeline_id": "google_sheets_pipeline",
      "mapping": {
        "crm_id_column": "string",
        "name_column": "string",
        "contact_column": "string",
        "contact_type_column": "phone",
        "contact_platform_column": "string",
        "contact_type_default": "phone",
        "contact_platform_default": "telegram",
        "stage_column": "stage",
        "crm_fields_columns": [
          "string"
        ],
        "document_columns": [
          "string"
        ],
        "dialogue_history_column": "string",
        "crm_fields_dump_column": "string",
        "summary_column": "string"
      }
    },
    "rate_limit_requests": 7,
    "rate_limit_period": 1,
    "responsible_whitelist_enabled": false,
    "responsible_whitelist": [
      "string"
    ],
    "crm_id_whitelist": [
      "string"
    ],
    "crm_id_whitelist_enabled": false,
    "skip_if_multiple_recent_tickets": false,
    "skip_if_multiple_recent_tickets_threshold_hours": 72,
    "secrets": {
      "client_id": "string",
      "client_secret": "string",
      "redirect_uri": "string",
      "service_account_json": {}
    },
    "tokens": {
      "access_token": "string",
      "refresh_token": "string",
      "account_id": "",
      "token_type": "",
      "expires_at": "2024-07-29T15:51:28.071Z",
      "referer": "",
      "application_token": "string"
    },
    "version": "v1",
    "amojo_id": "string",
    "chat_scope_id": "string",
    "chat_channel_id": "string",
    "chat_bot_id": "string",
    "chat_client_secret": "string",
    "agent_id": "string",
    "amocrm_salesbot_bot_id": 0,
    "bitrix24_openlines_bot_id": 0
  }
}