Kommo Website Buttons API

The Website Buttons API from Kommo — 4 operation(s) for website buttons.

GitHub OpenAPI

Operations 6

GET /api/v4/website_buttons/{source_id}oint Get apiv4website buttons{source id}oint #
GET /api/v4/website_buttons Get list of Website chat buttons #
POST /api/v4/website_buttons Add CRM Plugin #
GET /api/v4/website_buttons/{source_id} Get Website chat button #
PATCH /api/v4/website_buttons/{source_id} Update CRM Plugin #
POST /api/v4/website_buttons/{source_id}/online_chat Connect online chat to CRM Plugin #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/kommo:kommo-website-buttons-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kommo-website-buttons-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Kommo Website Buttons API
  version: '1.0'
  description: 'Operations tagged Website Buttons across 2 of this provider''s published API definitions: kommo-api-openapi.yml, kommo-api-references-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdominio}.kommo.com
  variables:
    subdominio:
      default: subdominio
- url: https://{subdomain}.kommo.com
  variables:
    subdomain:
      default: subdomain
security:
- sec0: []
tags:
- name: Website Buttons
paths:
  /api/v4/website_buttons/{source_id}oint:
    get:
      description: ''
      operationId: get_apiv4website_buttons{source_id}oint
      responses:
        '200':
          description: Respuesta completada con éxito. Ejemplo.
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                Respuesta completada con éxito.:
                  summary: Respuesta completada con éxito.
                  value:
                    account_id: 22521521
                    source_id: 64646723
                    button_id: 27537
                    is_duplication_control_enabled: false
                    name: ''
                    creation_status: created
                    pipeline_id: 591512
                    script: <script></script>
        '400':
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                'El usuario no está autorizado. ':
                  summary: 'El usuario no está autorizado. '
                  value: '{}'
          description: Bad Request
      parameters:
      - in: path
        name: source_id
        schema:
          type: string
        required: true
        description: ID de la fuente añadida al pipeline
      - in: query
        name: with
        schema:
          type: string
          enum:
          - scripts
        description: Añade el script del complemento del CRM a la respuesta
      tags:
      - Website Buttons
      summary: Get apiv4website buttons{source id}oint
      x-summary-source: derived
    servers:
    - url: https://{subdominio}.kommo.com
      variables:
        subdominio:
          default: subdominio
  /api/v4/website_buttons:
    get:
      summary: Get list of Website chat buttons
      description: The method allows you to get a paginated list of parameters of all CRM Plugins in your account.
      operationId: get-list-crm-plugin
      parameters:
      - name: Content-Type
        in: header
        description: Request header
        schema:
          type: string
          default: application/json
      - name: with
        in: query
        description: Adds the CRM Plugin script to the response
        schema:
          type: string
          enum:
          - scripts
      - name: page
        in: query
        description: Page number. It is set to 1 by default.
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: Number of objects per page. It is set to 250 (max) by default.
        schema:
          type: integer
          format: int32
          default: 250
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Request completed successfully:
                  value: "{\n    \"_page\": 1,\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://subdomain.kommo.com/api/v4/website_buttons/?with=scripts&page=1&limit=250\"\n        }\n    },\n    \"_embedded\": {\n        \"website_buttons\": [\n            {\n                \"account_id\": 31952118,\n                \"source_id\": 29181,\n                \"button_id\": 401034,\n                \"is_duplication_control_enabled\": false,\n                \"name\": \"\",\n                \"creation_status\": \"created\",\n                \"pipeline_id\": 7714034,\n                \"script\": \"<script></script>\"\n            },\n            {\n                \"account_id\": 31952118,\n                \"source_id\": 29193,\n                \"button_id\": 401040,\n                \"is_duplication_control_enabled\": false,\n                \"name\": \"\",\n                \"creation_status\": \"created\",\n                \"pipeline_id\": 7714034,\n                \"script\": \"<script></script>\"\n            },\n            {\n                \"account_id\": 31952118,\n                \"source_id\": 29223,\n                \"button_id\": 401046,\n                \"is_duplication_control_enabled\": false,\n                \"name\": \"\",\n                \"creation_status\": \"created\",\n                \"pipeline_id\": 7714482,\n                \"script\": \"<script></script>\"\n            }\n        ]\n    }\n}"
              schema:
                type: object
                properties:
                  _page:
                    type: integer
                    example: 1
                    default: 0
                  _links:
                    type: object
                    properties:
                      self:
                        type: object
                        properties:
                          href:
                            type: string
                            example: https://subdomain.kommo.com/api/v4/website_buttons/?with=scripts&page=1&limit=250
                  _embedded:
                    type: object
                    properties:
                      website_buttons:
                        type: array
                        items:
                          type: object
                          properties:
                            account_id:
                              type: integer
                              example: 31952118
                              default: 0
                            source_id:
                              type: integer
                              example: 29181
                              default: 0
                            button_id:
                              type: integer
                              example: 401034
                              default: 0
                            is_duplication_control_enabled:
                              type: boolean
                              example: false
                              default: true
                            name:
                              type: string
                              example: ''
                            creation_status:
                              type: string
                              example: created
                            pipeline_id:
                              type: integer
                              example: 7714034
                              default: 0
                            script:
                              type: string
                              example: <script></script>
        '401':
          description: '401'
          content:
            application/json:
              examples:
                The user isn't authorized.:
                  value: '{}'
              schema:
                type: object
                properties: {}
      tags:
      - Website Buttons
    post:
      summary: Add CRM Plugin
      description: This method enables you to add a CRM Plugin. Once you make the request, the source in the pipeline is created immediately, while the CRM Plugin settings are created asynchronously (outside the context of the request).
      operationId: add-crm-plugin
      parameters:
      - name: Content-Type
        in: header
        description: Request header
        schema:
          type: string
          default: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - pipeline_id
              properties:
                pipeline_id:
                  type: integer
                  description: Pipeline ID
                  format: int32
                trusted_websites:
                  type: array
                  description: Trusted domains where the CRM Plugin will be loaded
                  items:
                    type: string
                is_used_in_app:
                  type: boolean
                  description: If you create the CRM Plugin without trusted domains, you must pass this parameter.
            examples:
              Request Example:
                value:
                  pipeline_id: 123456
                  trusted_websites:
                  - example.com
      responses:
        '202':
          description: '202'
          content:
            application/json:
              examples:
                The source was created successfully, the process of a CRM Plugin addition was successfully launched:
                  value: "{\n    \"source_id\": 62112321,\n    \"trusted_websites\": [\"example.com\"]\n}"
              schema:
                type: object
                properties:
                  source_id:
                    type: integer
                    example: 62112321
                    default: 0
                  trusted_websites:
                    type: array
                    items:
                      type: string
                      example: example.com
        '400':
          description: '400'
          content:
            application/json:
              examples:
                The pipelie wasn't found in the account:
                  value: '{}'
              schema:
                type: object
                properties: {}
            text/plain:
              examples:
                An empty array "trusted_websites" was passed with the parameter "is_used_in_app" equal to false:
                  value: ''
                Incorrect format of parameters in the request body:
                  value: ''
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Integration is not authorized:
                  value: ''
      deprecated: false
      tags:
      - Website Buttons
    servers:
    - url: https://{subdomain}.kommo.com
      variables:
        subdomain:
          default: subdomain
  /api/v4/website_buttons/{source_id}:
    get:
      summary: Get Website chat button
      description: The method allows you to obtain the parameters of one CRM Plugin.
      operationId: get-crm-plugin
      parameters:
      - name: source_id
        in: path
        description: ID of the source added to the pipeline
        schema:
          type: integer
          format: int32
        required: true
      - name: Content-Type
        in: header
        description: Request header
        schema:
          type: string
          default: application/json
      - name: with
        in: query
        description: Adds the CRM Plugin script to the response
        schema:
          type: string
          enum:
          - scripts
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Request completed successfully:
                  value: "{\n    \"account_id\": 22521521,\n    \"source_id\": 64646723,\n    \"button_id\": 27537,\n    \"is_duplication_control_enabled\": false,\n    \"name\": \"\",\n    \"creation_status\": \"created\",\n    \"pipeline_id\": 591512,\n    \"script\": \"<script></script>\"\n}"
              schema:
                type: object
                properties:
                  account_id:
                    type: integer
                    example: 22521521
                    default: 0
                  source_id:
                    type: integer
                    example: 64646723
                    default: 0
                  button_id:
                    type: integer
                    example: 27537
                    default: 0
                  is_duplication_control_enabled:
                    type: boolean
                    example: false
                    default: true
                  name:
                    type: string
                    example: ''
                  creation_status:
                    type: string
                    example: created
                  pipeline_id:
                    type: integer
                    example: 591512
                    default: 0
                  script:
                    type: string
                    example: <script></script>
        '401':
          description: '401'
          content:
            application/json:
              examples:
                The user is not authorized:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '404':
          description: '404'
          content:
            text/plain:
              examples:
                The source isn't found:
                  value: ''
      tags:
      - Website Buttons
    patch:
      summary: Update CRM Plugin
      description: This method enables users to modify an existing CRM Plugin. Users can add new trusted domains to an existing CRM Plugin, but the addition occurs asynchronously, outside of the request context.
      operationId: update-crm-plugin
      parameters:
      - name: Content-Type
        in: header
        description: Request headers
        schema:
          type: string
          default: application/json
      - name: source_id
        in: path
        description: ID of the source added to the pipeline
        schema:
          type: integer
          format: int32
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                trusted_websites:
                  type: object
                  properties:
                    add:
                      type: array
                      description: An array of domains to be added
                      items:
                        type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Request to add trusted domains successfully accepted:
                  value: "{\n    \"account_id\": 22521521,\n    \"source_id\": 64646723,\n    \"button_id\": 27537,\n    \"is_duplication_control_enabled\": false,\n    \"name\": \"\",\n    \"creation_status\": \"created\",\n    \"pipeline_id\": 591512,\n    \"script\": \"<script></script>\"\n}"
              schema:
                type: object
                properties:
                  account_id:
                    type: integer
                    example: 22521521
                    default: 0
                  source_id:
                    type: integer
                    example: 64646723
                    default: 0
                  button_id:
                    type: integer
                    example: 27537
                    default: 0
                  is_duplication_control_enabled:
                    type: boolean
                    example: false
                    default: true
                  name:
                    type: string
                    example: ''
                  creation_status:
                    type: string
                    example: created
                  pipeline_id:
                    type: integer
                    example: 591512
                    default: 0
                  script:
                    type: string
                    example: <script></script>
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Integration isn't authorized:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '404':
          description: '404'
          content:
            text/plain:
              examples:
                The source isn't found:
                  value: ''
      deprecated: false
      tags:
      - Website Buttons
    servers:
    - url: https://{subdomain}.kommo.com
      variables:
        subdomain:
          default: subdomain
  /api/v4/website_buttons/{source_id}/online_chat:
    post:
      summary: Connect online chat to CRM Plugin
      description: This method enables you to link an online chat to the CRM Plugin. The process of creating an online chat and connecting it to the CRM Plugin happens asynchronously, and not in the context of a request.
      operationId: connect-online-chat-to-crm-plugin
      parameters:
      - name: source_id
        in: path
        description: ID of the source added to the pipeline
        schema:
          type: string
        required: true
      responses:
        '202':
          description: '202'
          content:
            application/json:
              examples:
                The request to link an online chat to the CRM Plugin has been successfully received.:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Website Buttons
    servers:
    - url: https://{subdomain}.kommo.com
      variables:
        subdomain:
          default: subdomain
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-refined-from:
- kommo-api-openapi.yml
- kommo-api-references-api-openapi.yml
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://developers.kommo.com/reference
  harvested: '2026-11-15'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.kommo.com/reference/ai-add-source-file.md
  - https://developers.kommo.com/reference/ai-add-source-text.md
  - https://developers.kommo.com/reference/ai-add-source-url.md
  - https://developers.kommo.com/reference/launch-import-of-products-from-crm-to-ai.md
  - https://pt-developers.kommo.com/reference/ai-add-source-file.md
  - https://pt-developers.kommo.com/reference/ai-add-source-text.md
  - https://pt-developers.kommo.com/reference/ai-add-source-url.md
  - https://pt-developers.kommo.com/reference/launch-import-of-products-from-crm-to-ai.md
  merge:
    pages: 8
    deduped: 7
    conflicts_kept_first: 4