openapi: 3.1.0 info: title: amoCRM API version: 0.1.0 tags: [] paths: /api/v2/salesbot/run: post: operationId: Salesbot_run description: Run salesbot (batch, up to 100 tasks). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/SalesbotRunResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/SalesbotRunItem' /api/v4/account: get: operationId: Account_get description: Get account info. parameters: - name: with in: query required: false description: Additional data to include (comma-separated). schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AccountInfo' application/hal+json: schema: $ref: '#/components/schemas/AccountInfo' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/calls: post: operationId: Calls_create description: Add calls (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CallCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CallCreateItem' /api/v4/catalogs: get: operationId: Catalogs_list description: Get catalogs list. parameters: - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Catalogs_create description: Create catalogs. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CatalogCreateItem' patch: operationId: Catalogs_update description: Update catalogs (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CatalogUpdateItem' /api/v4/catalogs/{catalog_id}/elements: get: operationId: CatalogElements_list description: Get catalog elements list. parameters: - name: catalog_id in: path required: true schema: type: integer format: int64 - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: query in: query required: false schema: anyOf: - type: string - type: integer format: int64 explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogElementListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: CatalogElements_create description: Create catalog elements. parameters: - name: catalog_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogElementCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CatalogElementCreateItem' patch: operationId: CatalogElements_update description: Update catalog elements (batch). parameters: - name: catalog_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogElementUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CatalogElementUpdateItem' /api/v4/catalogs/{catalog_id}/elements/{id}: get: operationId: CatalogElements_getById description: Get catalog element by id. parameters: - name: catalog_id in: path required: true schema: type: integer format: int64 - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false description: Additional data to include (comma-separated). schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogElement' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: CatalogElements_updateById description: Update catalog element by id. parameters: - name: catalog_id in: path required: true schema: type: integer format: int64 - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogElementUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CatalogElementUpdateById' /api/v4/catalogs/{id}: get: operationId: Catalogs_getById description: Get catalog by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Catalog' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Catalogs_updateById description: Update catalog by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CatalogUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CatalogUpdateById' /api/v4/companies: get: operationId: Companies_list description: Get a list of companies (pagination, sorting, filtering). parameters: - name: page in: query required: false description: Pagination page schema: type: integer format: int32 explode: false - name: limit in: query required: false description: Pagination limit schema: type: integer format: int32 explode: false - name: query in: query required: false description: Search by query string or id schema: anyOf: - type: string - type: integer format: int64 explode: false - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false - name: order in: query required: false description: Sorting, e.g. order[updated_at]=asc schema: type: object unevaluatedProperties: {} explode: false - name: filter in: query required: false description: Filtering parameters schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CompanyListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Companies_create description: Create companies. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CompanyCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CompanyCreateItem' patch: operationId: Companies_update description: Update companies (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CompanyUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CompanyUpdateItem' /api/v4/companies/{id}: get: operationId: Companies_getById description: Get a company by id. parameters: - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Company' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Companies_updateById description: Update a company by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CompanyUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CompanyUpdateById' /api/v4/contacts: get: operationId: Contacts_list description: Get a list of contacts (pagination, sorting, filtering). parameters: - name: page in: query required: false description: Pagination page schema: type: integer format: int32 explode: false - name: limit in: query required: false description: Pagination limit schema: type: integer format: int32 explode: false - name: query in: query required: false description: Search by query string or id schema: anyOf: - type: string - type: integer format: int64 explode: false - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false - name: order in: query required: false description: Sorting, e.g. order[updated_at]=asc schema: type: object unevaluatedProperties: {} explode: false - name: filter in: query required: false description: Filtering parameters schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ContactListResponse' application/hal+json: schema: $ref: '#/components/schemas/ContactListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Contacts_create description: Create contacts. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ContactCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactCreateItem' patch: operationId: Contacts_update description: Update contacts (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ContactUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactUpdateItem' /api/v4/contacts/chats: get: operationId: ContactChats_list description: Get list of linked chats. parameters: - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ContactChatLinksResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: ContactChats_link description: Link chats to contacts. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ContactChatLinksResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/ContactChatLink' /api/v4/contacts/{id}: get: operationId: Contacts_getById description: Get a contact by id. parameters: - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Contact' application/hal+json: schema: $ref: '#/components/schemas/Contact' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Contacts_updateById description: Update a contact by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ContactUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ContactUpdateById' /api/v4/customers: get: operationId: Customers_list description: Get a list of customers. parameters: - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: query in: query required: false schema: anyOf: - type: string - type: integer format: int64 explode: false - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false - name: order in: query required: false schema: type: object unevaluatedProperties: {} explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Customers_create description: Create customers. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerCreateItem' patch: operationId: Customers_update description: Update customers (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerUpdateItem' /api/v4/customers/mode: patch: operationId: CustomersMode_setMode description: Enable or switch customers mode. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerModeResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerModeRequest' /api/v4/customers/segments: get: operationId: CustomerSegments_list description: Get segments list. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerSegmentListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: CustomerSegments_create description: Create segments. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerSegmentCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerSegmentCreate' /api/v4/customers/segments/{id}: get: operationId: CustomerSegments_getById description: Get segment by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerSegment' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: CustomerSegments_updateById description: Update a segment by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerSegmentUpdateById' delete: operationId: CustomerSegments_deleteById description: Delete a segment by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/customers/statuses: get: operationId: CustomerStatuses_list description: Get statuses list. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerStatusListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: CustomerStatuses_create description: Create statuses. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerStatusCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerStatusCreate' /api/v4/customers/statuses/{id}: get: operationId: CustomerStatuses_getById description: Get status by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerStatus' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: CustomerStatuses_updateById description: Update a status by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerStatusUpdateById' delete: operationId: CustomerStatuses_deleteById description: Delete a status by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/customers/transactions: get: operationId: CustomerTransactions_list description: Get list of transactions. parameters: - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerTransactionListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/customers/{customer_id}/bonus_points: post: operationId: CustomerBonusPoints_change description: Earn or redeem bonus points. parameters: - name: customer_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerBonusPointsResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: anyOf: - $ref: '#/components/schemas/CustomerBonusPointsEarn' - $ref: '#/components/schemas/CustomerBonusPointsRedeem' /api/v4/customers/{customer_id}/transactions: get: operationId: CustomerTransactions_listByCustomer description: Get list of transactions for a customer. parameters: - name: customer_id in: path required: true schema: type: integer format: int64 - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerTransactionListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: CustomerTransactions_create description: Create transactions for a customer. parameters: - name: customer_id in: path required: true schema: type: integer format: int64 - name: accrue_bonus in: query required: false schema: type: boolean explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerTransactionCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerTransactionCreate' /api/v4/customers/{customer_id}/transactions/{transaction_id}: delete: operationId: CustomerTransactions_deleteById description: Delete a transaction for a customer. parameters: - name: customer_id in: path required: true schema: type: integer format: int64 - name: transaction_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/customers/{id}: get: operationId: Customers_getById description: Get a customer by id. parameters: - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Customer' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Customers_updateById description: Update a customer by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomerUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerUpdateById' /api/v4/events: get: operationId: Events_list description: Get events list. parameters: - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: with in: query required: false schema: type: string explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EventListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/events/types: get: operationId: Events_listTypes description: Get event types. parameters: - name: language_code in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EventTypesResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/events/{id}: get: operationId: Events_getById description: Get event by id. parameters: - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Event' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/leads: get: operationId: Leads_list description: Get a list of leads (pagination, sorting, filtering). parameters: - name: page in: query required: false description: Pagination page schema: type: integer format: int32 explode: false - name: limit in: query required: false description: Pagination limit schema: type: integer format: int32 explode: false - name: query in: query required: false description: Search by query string or id schema: anyOf: - type: string - type: integer format: int64 explode: false - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false - name: order in: query required: false description: Sorting, e.g. order[updated_at]=asc schema: type: object unevaluatedProperties: {} explode: false - name: filter in: query required: false description: Filtering parameters, see filters API schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/LeadListResponse' application/hal+json: schema: $ref: '#/components/schemas/LeadListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Leads_create description: Create leads. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/LeadCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/LeadCreate' patch: operationId: Leads_update description: Update leads (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/LeadUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/LeadUpdateItem' /api/v4/leads/complex: post: operationId: Leads_createComplex description: Create leads using the complex method (supports unsorted metadata). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/LeadComplexCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/LeadCreate' /api/v4/leads/pipelines: get: operationId: Pipelines_list description: Get pipelines list. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PipelineListResponse' application/hal+json: schema: $ref: '#/components/schemas/PipelineListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Pipelines_create description: Create pipelines. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PipelineCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/PipelineCreateItem' patch: operationId: Pipelines_update description: Update pipelines (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PipelineUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/PipelineUpdateItem' /api/v4/leads/pipelines/{id}: get: operationId: Pipelines_getById description: Get pipeline by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Pipeline' application/hal+json: schema: $ref: '#/components/schemas/Pipeline' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Pipelines_updateById description: Update pipeline by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PipelineUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PipelineUpdateById' delete: operationId: Pipelines_deleteById description: Delete pipeline by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/leads/pipelines/{pipeline_id}/statuses: get: operationId: PipelineStatuses_list description: Get statuses for a pipeline. parameters: - name: pipeline_id in: path required: true schema: type: integer format: int64 - name: with in: query required: false description: Expand related entities; comma-separated values (e.g. descriptions). schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StatusListResponse' application/hal+json: schema: $ref: '#/components/schemas/StatusListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: PipelineStatuses_create description: Create statuses. parameters: - name: pipeline_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StatusCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/StatusCreateItem' patch: operationId: PipelineStatuses_update description: Update statuses (batch). parameters: - name: pipeline_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StatusUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/StatusUpdateItem' /api/v4/leads/pipelines/{pipeline_id}/statuses/{id}: get: operationId: PipelineStatuses_getById description: Get status by id. parameters: - name: pipeline_id in: path required: true schema: type: integer format: int64 - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false description: Expand related entities; comma-separated values (e.g. descriptions). schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Status' application/hal+json: schema: $ref: '#/components/schemas/Status' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: PipelineStatuses_updateById description: Update status by id. parameters: - name: pipeline_id in: path required: true schema: type: integer format: int64 - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StatusUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StatusUpdateById' delete: operationId: PipelineStatuses_deleteById description: Delete status by id. parameters: - name: pipeline_id in: path required: true schema: type: integer format: int64 - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/leads/unsorted/forms: post: operationId: UnsortedLeads_createForms parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/UnsortedCreateResponse' application/hal+json: schema: $ref: '#/components/schemas/UnsortedCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/UnsortedFormCreateItem' /api/v4/leads/unsorted/{uid}/accept: post: operationId: UnsortedLeads_accept parameters: - name: uid in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/UnsortedAcceptResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UnsortedAcceptRequest' /api/v4/leads/unsorted/{uid}/decline: delete: operationId: UnsortedLeads_decline parameters: - name: uid in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/UnsortedAcceptResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UnsortedDeclineRequest' /api/v4/leads/{id}: get: operationId: Leads_getById description: Get a lead by id. parameters: - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false description: Expand related entities; comma-separated values schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Lead' application/hal+json: schema: $ref: '#/components/schemas/Lead' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Leads_updateById description: Update a lead by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/LeadUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LeadUpdateById' /api/v4/roles: get: operationId: Roles_list description: Get roles list. parameters: - name: with in: query required: false schema: type: string explode: false - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/RoleListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Roles_create description: Create roles (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/RoleCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/RoleCreateItem' /api/v4/roles/{id}: get: operationId: Roles_getById description: Get role by id. parameters: - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Role' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Roles_updateById description: Update role by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Role' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RoleUpdateById' delete: operationId: Roles_deleteById description: Delete role by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/short_links: post: operationId: ShortLinks_create description: Create short link. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ShortLinkCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ShortLinkCreateRequest' /api/v4/sources: get: operationId: Sources_list description: Get sources list. parameters: - name: filter in: query required: false schema: type: object properties: external_id: anyOf: - type: string - type: integer format: int64 - type: boolean - type: array items: anyOf: - type: string - type: integer format: int64 - type: boolean explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/SourceListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Sources_create description: Create sources (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/SourceCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/SourceCreateItem' patch: operationId: Sources_update description: Update sources (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/SourceUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/SourceUpdateItem' delete: operationId: Sources_delete description: Delete sources (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/SourceDeleteItem' /api/v4/sources/{id}: get: operationId: Sources_getById description: Get source by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Source' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Sources_updateById description: Update source by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/SourceUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SourceUpdateById' delete: operationId: Sources_deleteById description: Delete source by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/talks/{id}: get: operationId: Talks_getById description: Get talk by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Talk' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/talks/{id}/close: post: operationId: Talks_close description: Close talk by id (optionally force without NPS bot). parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TalkCloseRequest' /api/v4/tasks: get: operationId: Tasks_list description: Get a list of tasks (pagination, sorting, filtering). parameters: - name: page in: query required: false description: Pagination page schema: type: integer format: int32 explode: false - name: limit in: query required: false description: Pagination limit schema: type: integer format: int32 explode: false - name: query in: query required: false description: Search by query string or id schema: anyOf: - type: string - type: integer format: int64 explode: false - name: order in: query required: false description: Sorting, e.g. order[updated_at]=asc schema: type: object unevaluatedProperties: {} explode: false - name: filter in: query required: false description: Filtering parameters schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TaskListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Tasks_create description: Create tasks. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TaskCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/TaskCreate' patch: operationId: Tasks_update description: Update tasks (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TaskUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/TaskUpdateItem' /api/v4/tasks/{id}: get: operationId: Tasks_getById description: Get a task by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Task' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: Tasks_updateById description: Update a task by id. parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TaskUpdateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TaskUpdateById' /api/v4/users: get: operationId: Users_list description: Get users list. parameters: - name: with in: query required: false schema: type: string explode: false - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/UserListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Users_create description: Create users (batch). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/UserCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/UserCreateItem' /api/v4/users/{id}: get: operationId: Users_getById description: Get user by id. parameters: - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/User' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/webhooks: get: operationId: Webhooks_list description: Get webhooks list. parameters: - name: filter in: query required: false schema: type: object properties: destination: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WebhookListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Webhooks_subscribe description: Subscribe to webhook events. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Webhook' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebhookSubscribeRequest' delete: operationId: Webhooks_unsubscribe description: Unsubscribe webhook by destination. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebhookUnsubscribeRequest' /api/v4/website_buttons: get: operationId: WebsiteButtons_list description: Get CRM Plugin list. parameters: - name: with in: query required: false schema: type: string explode: false - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WebsiteButtonListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: WebsiteButtons_create description: Create CRM Plugin. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WebsiteButtonCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebsiteButtonCreateRequest' /api/v4/website_buttons/{source_id}: get: operationId: WebsiteButtons_getBySourceId description: Get CRM Plugin by source id. parameters: - name: source_id in: path required: true schema: type: integer format: int64 - name: with in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WebsiteButton' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: WebsiteButtons_update description: Update CRM Plugin trusted domains. parameters: - name: source_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WebsiteButton' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebsiteButtonUpdateRequest' /api/v4/website_buttons/{source_id}/online_chat: post: operationId: WebsiteButtons_connectOnlineChat description: Connect online chat to CRM Plugin. parameters: - name: source_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/widgets: get: operationId: Widgets_list description: Get widgets list. parameters: - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WidgetListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/widgets/{widget_code}: get: operationId: Widgets_getByCode description: Get widget info by code. parameters: - name: widget_code in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Widget' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Widgets_install description: Install widget in account. parameters: - name: widget_code in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Widget' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: object unevaluatedProperties: {} delete: operationId: Widgets_uninstall description: Uninstall widget from account. parameters: - name: widget_code in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/{bot_type}/{bot_id}/continue/{continue_id}: post: operationId: WidgetBotContinue_continue parameters: - name: bot_type in: path required: true schema: type: string enum: - salesbot - marketingbot - name: bot_id in: path required: true schema: type: integer format: int64 - name: continue_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WidgetContinueRequest' /api/v4/{entity_type}/custom_fields: get: operationId: CustomFields_list description: Get custom fields list. parameters: - name: entity_type in: path required: true schema: type: string - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomFieldListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: CustomFields_create description: Create custom fields. parameters: - name: entity_type in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomFieldCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomFieldCreate' patch: operationId: CustomFields_update description: Update custom fields (batch). parameters: - name: entity_type in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomFieldUpdateItem' /api/v4/{entity_type}/custom_fields/groups: get: operationId: CustomFieldGroups_list description: Get custom field groups list. parameters: - name: entity_type in: path required: true schema: type: string - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomFieldGroupListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: CustomFieldGroups_create description: Create custom field groups. parameters: - name: entity_type in: path required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomFieldGroupCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomFieldGroupCreate' /api/v4/{entity_type}/custom_fields/groups/{id}: get: operationId: CustomFieldGroups_getById description: Get custom field group by id. parameters: - name: entity_type in: path required: true schema: type: string - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomFieldGroup' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: CustomFieldGroups_updateById description: Update a custom field group by id. parameters: - name: entity_type in: path required: true schema: type: string - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomFieldGroupUpdateById' delete: operationId: CustomFieldGroups_deleteById description: Delete a custom field group by id. parameters: - name: entity_type in: path required: true schema: type: string - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/{entity_type}/custom_fields/{id}: get: operationId: CustomFields_getById description: Get custom field by id. parameters: - name: entity_type in: path required: true schema: type: string - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CustomField' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: CustomFields_updateById description: Update a custom field by id. parameters: - name: entity_type in: path required: true schema: type: string - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomFieldUpdateById' delete: operationId: CustomFields_deleteById description: Delete a custom field by id. parameters: - name: entity_type in: path required: true schema: type: string - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: type: object unevaluatedProperties: {} default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/{entity_type}/link: post: operationId: EntityLinks_link description: Link entities (bulk). parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/EntityLinkItem' /api/v4/{entity_type}/links: get: operationId: EntityLinks_list description: Get list of linked entities (bulk). parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EntityLinksResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/{entity_type}/notes: get: operationId: EntityNotes_list description: Get notes list for entity type. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: EntityNotes_create description: Create notes for entity type. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteCreate' patch: operationId: EntityNotes_update description: Update notes for entity type (batch). parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteUpdateItem' /api/v4/{entity_type}/notes/{id}: get: operationId: EntityNotes_getById description: Get note by id. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: id in: path required: true schema: type: integer format: int64 - name: with in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Note' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: EntityNotes_updateById description: Update note by id. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NoteUpdateById' /api/v4/{entity_type}/notes/{id}/pin: post: operationId: EntityNotes_pin description: Pin note by id. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/{entity_type}/notes/{id}/unpin: post: operationId: EntityNotes_unpin description: Unpin note by id. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/{entity_type}/tags: get: operationId: Tags_list description: Get tags list. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: query in: query required: false schema: type: string explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TagListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: Tags_create description: Create tags. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TagCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/TagCreate' /api/v4/{entity_type}/unlink: post: operationId: EntityLinks_unlink description: Unlink entities (bulk). parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/EntityLinkItem' /api/v4/{entity_type}/{entity_id}/followers: get: operationId: EntityFollowers_list description: Get followers list. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EntityFollowerListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: EntityFollowers_add description: Add followers. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EntityFollowerCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/EntityFollowerCreateItem' delete: operationId: EntityFollowers_remove description: Remove followers. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/EntityFollowerDeleteItem' /api/v4/{entity_type}/{entity_id}/link: post: operationId: EntityLinks_linkByEntity description: Link entities for a specific entity. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/EntityLinkItem' /api/v4/{entity_type}/{entity_id}/links: get: operationId: EntityLinks_listByEntity description: Get links for a specific entity. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EntityLinksResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /api/v4/{entity_type}/{entity_id}/notes: get: operationId: EntityNotesByParent_listByParent description: Get notes list for a specific entity. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 - name: page in: query required: false schema: type: integer format: int32 explode: false - name: limit in: query required: false schema: type: integer format: int32 explode: false - name: filter in: query required: false schema: type: object unevaluatedProperties: {} explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteListResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' post: operationId: EntityNotesByParent_createByParent description: Create notes for a specific entity. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteCreate' patch: operationId: EntityNotesByParent_updateByParent description: Update notes for a specific entity (batch). parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/NoteUpdateItem' /api/v4/{entity_type}/{entity_id}/notes/{note_id}: get: operationId: EntityNotesByParent_getByParentId description: Get note by id for a specific entity. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 - name: note_id in: path required: true schema: type: integer format: int64 - name: with in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Note' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' patch: operationId: EntityNotesByParent_updateByParentId description: Update note by id for a specific entity. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 - name: note_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NoteCreateResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NoteUpdateByParentId' /api/v4/{entity_type}/{entity_id}/unlink: post: operationId: EntityLinks_unlinkByEntity description: Unlink entities for a specific entity. parameters: - name: entity_type in: path required: true schema: $ref: '#/components/schemas/EntityLinkType' - name: entity_id in: path required: true schema: type: integer format: int64 responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' default: description: An unexpected error response. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/EntityLinkItem' security: - BearerAuth: [] components: schemas: AccountCustomersMode: type: string enum: - periodicity - dynamic - segments - disabled - unavailable AccountEmbedded: type: object properties: amojo_rights: $ref: '#/components/schemas/AmojoRights' users_groups: type: array items: $ref: '#/components/schemas/UsersGroup' task_types: type: array items: $ref: '#/components/schemas/TaskType' datetime_settings: $ref: '#/components/schemas/DateTimeSettings' AccountInfo: type: object properties: id: type: integer format: int64 name: type: string subdomain: type: string created_at: type: integer format: int64 created_by: type: integer format: int64 updated_at: type: integer format: int64 updated_by: type: integer format: int64 current_user_id: type: integer format: int64 country: type: string currency: type: string currency_symbol: type: string is_unsorted_on: type: boolean mobile_feature_version: type: integer format: int32 customers_mode: anyOf: - $ref: '#/components/schemas/AccountCustomersMode' - type: string is_loss_reason_enabled: type: boolean is_helpbot_enabled: type: boolean contact_name_display_order: type: integer format: int32 is_technical_account: type: boolean amojo_id: type: string uuid: type: string version: type: integer format: int32 invoices_settings: $ref: '#/components/schemas/InvoicesSettings' is_api_filter_enabled: type: boolean drive_url: type: string _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/AccountEmbedded' AmojoRights: type: object properties: can_direct: type: boolean can_create_groups: type: boolean CallCreateItem: type: object required: - direction - duration - source - phone properties: direction: anyOf: - $ref: '#/components/schemas/CallDirection' - type: string uniq: type: string duration: type: integer format: int32 source: type: string link: type: string phone: type: string call_responsible: anyOf: - type: string - type: integer format: int64 - type: 'null' call_result: type: string call_status: type: integer format: int32 responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 request_id: type: string CallCreateResponse: type: object properties: _total_items: type: integer format: int32 errors: type: array items: type: object unevaluatedProperties: {} _embedded: type: object properties: calls: type: array items: $ref: '#/components/schemas/CallCreateResult' CallCreateResult: type: object properties: id: type: integer format: int64 entity_id: type: integer format: int64 entity_type: anyOf: - type: string - type: integer format: int32 account_id: type: integer format: int64 request_id: type: string _embedded: $ref: '#/components/schemas/CallEmbedded' CallDirection: type: string enum: - inbound - outbound CallEmbedded: type: object properties: entity: $ref: '#/components/schemas/CallEmbeddedEntity' CallEmbeddedEntity: type: object properties: id: type: integer format: int64 _links: type: object unevaluatedProperties: {} Catalog: type: object properties: id: type: integer format: int64 name: type: string created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 sort: type: integer format: int32 type: anyOf: - $ref: '#/components/schemas/CatalogType' - type: string can_add_elements: type: boolean can_show_in_cards: type: boolean can_link_multiple: type: boolean can_be_deleted: type: boolean sdk_widget_code: anyOf: - type: string - type: integer format: int32 - type: 'null' account_id: type: integer format: int64 _links: type: object unevaluatedProperties: {} CatalogCreateItem: type: object required: - name properties: name: type: string type: anyOf: - $ref: '#/components/schemas/CatalogType' - type: string sort: type: integer format: int32 can_add_elements: type: boolean can_link_multiple: type: boolean request_id: type: string CatalogCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: catalogs: type: array items: $ref: '#/components/schemas/CatalogCreateResult' CatalogCreateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/Catalog' CatalogCustomFieldValue: type: object required: - values properties: field_id: type: integer format: int64 field_code: type: string field_name: type: string field_type: type: string values: type: array items: $ref: '#/components/schemas/CatalogCustomFieldValueItem' CatalogCustomFieldValueItem: type: object required: - value properties: value: {} enum_id: type: integer format: int64 enum_code: type: string CatalogElement: type: object properties: id: type: integer format: int64 catalog_id: type: integer format: int64 name: type: string created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 is_deleted: type: boolean custom_fields_values: anyOf: - type: array items: $ref: '#/components/schemas/CatalogCustomFieldValue' - type: 'null' account_id: type: integer format: int64 invoice_link: anyOf: - type: string - type: 'null' _embedded: $ref: '#/components/schemas/CatalogElementEmbedded' _links: type: object unevaluatedProperties: {} CatalogElementCreateItem: type: object required: - name properties: name: type: string custom_fields_values: type: array items: $ref: '#/components/schemas/CatalogCustomFieldValue' request_id: type: string CatalogElementCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: elements: type: array items: $ref: '#/components/schemas/CatalogElementCreateResult' CatalogElementCreateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/CatalogElement' CatalogElementEmbedded: type: object properties: warning: anyOf: - $ref: '#/components/schemas/CatalogElementWarning' - type: 'null' CatalogElementListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: elements: type: array items: $ref: '#/components/schemas/CatalogElement' CatalogElementRef: type: object properties: id: type: integer format: int64 metadata: type: object unevaluatedProperties: {} CatalogElementUpdateById: type: object properties: name: type: string custom_fields_values: type: array items: $ref: '#/components/schemas/CatalogCustomFieldValue' request_id: type: string CatalogElementUpdateItem: type: object required: - id properties: id: type: integer format: int64 name: type: string custom_fields_values: type: array items: $ref: '#/components/schemas/CatalogCustomFieldValue' request_id: type: string CatalogElementUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: elements: type: array items: $ref: '#/components/schemas/CatalogElementUpdateResult' CatalogElementUpdateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/CatalogElement' CatalogElementWarning: type: object properties: message: anyOf: - type: string - type: 'null' CatalogListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: catalogs: type: array items: $ref: '#/components/schemas/Catalog' CatalogType: type: string enum: - regular - invoices - products CatalogUpdateById: type: object properties: name: type: string sort: type: integer format: int32 can_add_elements: type: boolean can_link_multiple: type: boolean request_id: type: string CatalogUpdateItem: type: object required: - id properties: id: type: integer format: int64 name: type: string sort: type: integer format: int32 can_add_elements: type: boolean can_link_multiple: type: boolean request_id: type: string CatalogUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: catalogs: type: array items: $ref: '#/components/schemas/CatalogUpdateResult' CatalogUpdateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/Catalog' Company: type: object properties: id: type: integer format: int64 name: type: string responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 closest_task_at: type: integer format: int64 custom_fields_values: anyOf: - type: array items: $ref: '#/components/schemas/CustomFieldValue' - type: 'null' account_id: type: integer format: int64 _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/CompanyEmbedded' CompanyCreate: type: object properties: id: type: integer format: int64 name: type: string CompanyCreateItem: type: object properties: request_id: type: string description: Client-side request id name: type: string responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach _embedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' description: Embedded entities CompanyCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: companies: type: array items: $ref: '#/components/schemas/CompanyCreateResult' CompanyCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} CompanyEmbedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' contacts: type: array items: $ref: '#/components/schemas/RefEntity' leads: type: array items: $ref: '#/components/schemas/RefEntity' customers: type: array items: $ref: '#/components/schemas/RefEntity' catalog_elements: type: array items: $ref: '#/components/schemas/RefEntity' CompanyListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: companies: type: array items: $ref: '#/components/schemas/Company' CompanyUpdateById: type: object properties: name: type: string responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' description: Tags to delete _embedded: type: object properties: tags: anyOf: - type: array items: $ref: '#/components/schemas/Tag' - type: 'null' CompanyUpdateItem: type: object required: - id properties: id: type: integer format: int64 description: Company id name: type: string responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' description: Tags to delete _embedded: type: object properties: tags: anyOf: - type: array items: $ref: '#/components/schemas/Tag' - type: 'null' CompanyUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: companies: type: array items: $ref: '#/components/schemas/CompanyUpdatedResult' CompanyUpdatedResult: type: object properties: id: type: integer format: int64 updated_at: type: integer format: int64 _links: type: object unevaluatedProperties: {} Contact: type: object properties: id: type: integer format: int64 name: type: string first_name: type: string last_name: type: string responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 closest_task_at: type: integer format: int64 custom_fields_values: anyOf: - type: array items: $ref: '#/components/schemas/CustomFieldValue' - type: 'null' account_id: type: integer format: int64 is_unsorted: type: boolean _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/ContactEmbedded' ContactChatLink: type: object required: - contact_id - chat_id properties: contact_id: type: integer format: int64 chat_id: type: string request_id: type: string ContactChatLinksResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: chats: type: array items: $ref: '#/components/schemas/ContactChatLink' ContactCreate: type: object properties: id: type: integer format: int64 name: type: string first_name: type: string last_name: type: string custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload (same as contact create API) ContactCreateItem: type: object properties: request_id: type: string description: Client-side request id name: type: string first_name: type: string last_name: type: string responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach _embedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' description: Embedded entities ContactCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: contacts: type: array items: $ref: '#/components/schemas/ContactCreateResult' ContactCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} ContactEmbedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' leads: type: array items: $ref: '#/components/schemas/RefEntity' companies: type: array items: $ref: '#/components/schemas/RefEntity' customers: type: array items: $ref: '#/components/schemas/RefEntity' catalog_elements: type: array items: $ref: '#/components/schemas/RefEntity' social_profiles: type: array items: type: object unevaluatedProperties: {} ContactListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: contacts: type: array items: $ref: '#/components/schemas/Contact' ContactUpdateById: type: object properties: name: type: string first_name: type: string last_name: type: string responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' description: Tags to delete _embedded: type: object properties: tags: anyOf: - type: array items: $ref: '#/components/schemas/Tag' - type: 'null' ContactUpdateItem: type: object required: - id properties: id: type: integer format: int64 description: Contact id name: type: string first_name: type: string last_name: type: string responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' description: Tags to delete _embedded: type: object properties: tags: anyOf: - type: array items: $ref: '#/components/schemas/Tag' - type: 'null' ContactUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: contacts: type: array items: $ref: '#/components/schemas/ContactUpdatedResult' ContactUpdatedResult: type: object properties: id: type: integer format: int64 updated_at: type: integer format: int64 _links: type: object unevaluatedProperties: {} CustomField: type: object properties: id: type: integer format: int64 name: type: string type: type: string code: type: string is_multiple: type: boolean is_required: type: boolean is_deletable: type: boolean is_visible: type: boolean sort: type: integer format: int32 enums: type: array items: type: object unevaluatedProperties: {} settings: type: object unevaluatedProperties: {} entity_type: type: string group_id: type: integer format: int64 CustomFieldCreate: type: object required: - name - type properties: request_id: type: string description: Client-side request id name: type: string type: type: string code: type: string is_multiple: type: boolean is_required: type: boolean is_deletable: type: boolean is_visible: type: boolean sort: type: integer format: int32 enums: type: array items: type: object unevaluatedProperties: {} settings: type: object unevaluatedProperties: {} group_id: type: integer format: int64 CustomFieldCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldCreateResult' CustomFieldCreateResult: type: object properties: id: type: integer format: int64 name: type: string request_id: type: string CustomFieldGroup: type: object properties: id: type: integer format: int64 name: type: string sort: type: integer format: int32 is_predefined: type: boolean CustomFieldGroupCreate: type: object required: - name properties: request_id: type: string description: Client-side request id name: type: string sort: type: integer format: int32 CustomFieldGroupCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: groups: type: array items: $ref: '#/components/schemas/CustomFieldGroupCreateResult' CustomFieldGroupCreateResult: type: object properties: id: type: integer format: int64 name: type: string request_id: type: string CustomFieldGroupListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: groups: type: array items: $ref: '#/components/schemas/CustomFieldGroup' CustomFieldGroupUpdateById: type: object properties: name: type: string sort: type: integer format: int32 CustomFieldListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: custom_fields: type: array items: $ref: '#/components/schemas/CustomField' CustomFieldUpdateById: type: object properties: name: type: string type: type: string code: type: string is_multiple: type: boolean is_required: type: boolean is_deletable: type: boolean is_visible: type: boolean sort: type: integer format: int32 enums: type: array items: type: object unevaluatedProperties: {} settings: type: object unevaluatedProperties: {} group_id: type: integer format: int64 CustomFieldUpdateItem: type: object required: - id properties: id: type: integer format: int64 description: Custom field id name: type: string type: type: string code: type: string is_multiple: type: boolean is_required: type: boolean is_deletable: type: boolean is_visible: type: boolean sort: type: integer format: int32 enums: type: array items: type: object unevaluatedProperties: {} settings: type: object unevaluatedProperties: {} group_id: type: integer format: int64 CustomFieldValue: type: object required: - values properties: field_id: type: integer format: int64 description: Use either field_id or field_code (e.g. PHONE/EMAIL) field_code: type: string description: Field code (e.g. PHONE/EMAIL) values: type: array items: $ref: '#/components/schemas/CustomFieldValueItem' description: Values for the field (multiple values allowed) CustomFieldValueItem: type: object required: - value properties: value: anyOf: - type: string - type: integer format: int32 - type: boolean enum_id: type: integer format: int64 description: Option id for list/select custom fields (one of predefined options) enum_code: type: string description: Option code for list/select custom fields (if you use code instead of id) Customer: type: object properties: id: type: integer format: int64 name: type: string next_price: type: integer format: int64 next_date: type: integer format: int64 periodicity: type: integer format: int64 closest_task_at: type: integer format: int64 ltv: type: integer format: int64 purchases_count: type: integer format: int64 average_check: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 status_id: type: integer format: int64 responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 is_deleted: type: boolean main_user_id: type: integer format: int64 custom_fields_values: anyOf: - type: array items: $ref: '#/components/schemas/CustomFieldValue' - type: 'null' account_id: type: integer format: int64 _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/CustomerEmbedded' CustomerBonusPointsEarn: type: object required: - earn properties: earn: type: integer format: int64 CustomerBonusPointsRedeem: type: object required: - redeem properties: redeem: type: integer format: int64 CustomerBonusPointsResponse: type: object properties: bonus_points: type: integer format: int64 CustomerCreateItem: type: object properties: request_id: type: string name: type: string next_price: type: integer format: int64 next_date: type: integer format: int64 periodicity: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 status_id: type: integer format: int64 responsible_user_id: type: integer format: int64 main_user_id: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' tags_to_add: type: array items: $ref: '#/components/schemas/Tag' _embedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' segments: type: array items: $ref: '#/components/schemas/RefEntity' CustomerCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: customers: type: array items: $ref: '#/components/schemas/CustomerCreateResult' CustomerCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} CustomerEmbedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' contacts: type: array items: $ref: '#/components/schemas/RefEntity' companies: type: array items: $ref: '#/components/schemas/RefEntity' catalog_elements: type: array items: $ref: '#/components/schemas/RefEntity' segments: type: array items: $ref: '#/components/schemas/RefEntity' CustomerListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: customers: type: array items: $ref: '#/components/schemas/Customer' CustomerModeRequest: type: object required: - mode - is_enabled properties: mode: type: string enum: - segments - periodicity is_enabled: type: boolean CustomerModeResponse: type: object properties: mode: type: string enum: - segments - periodicity is_enabled: type: boolean CustomerSegment: type: object properties: id: type: integer format: int64 name: type: string color: type: string created_at: type: integer format: int64 updated_at: type: integer format: int64 customers_count: type: integer format: int64 custom_fields_values: anyOf: - type: array items: $ref: '#/components/schemas/CustomFieldValue' - type: 'null' CustomerSegmentCreate: type: object required: - name properties: request_id: type: string name: type: string color: type: string custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' CustomerSegmentCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: segments: type: array items: $ref: '#/components/schemas/CustomerSegmentCreateResult' CustomerSegmentCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} CustomerSegmentListResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: segments: type: array items: $ref: '#/components/schemas/CustomerSegment' CustomerSegmentUpdateById: type: object properties: name: type: string color: type: string custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' CustomerStatus: type: object properties: id: type: integer format: int64 name: type: string sort: type: integer format: int32 color: type: string type: type: string CustomerStatusCreate: type: object required: - name properties: request_id: type: string name: type: string sort: type: integer format: int32 color: type: string CustomerStatusCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: statuses: type: array items: $ref: '#/components/schemas/CustomerStatusCreateResult' CustomerStatusCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} CustomerStatusListResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: statuses: type: array items: $ref: '#/components/schemas/CustomerStatus' CustomerStatusUpdateById: type: object properties: name: type: string sort: type: integer format: int32 color: type: string CustomerTransaction: type: object properties: id: type: integer format: int64 customer_id: type: integer format: int64 price: type: integer format: int64 comment: type: string created_at: type: integer format: int64 created_by: type: integer format: int64 _links: type: object unevaluatedProperties: {} CustomerTransactionCreate: type: object required: - price properties: request_id: type: string price: type: integer format: int64 comment: type: string created_at: type: integer format: int64 created_by: type: integer format: int64 CustomerTransactionCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: transactions: type: array items: $ref: '#/components/schemas/CustomerTransactionCreateResult' CustomerTransactionCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} CustomerTransactionListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: transactions: type: array items: $ref: '#/components/schemas/CustomerTransaction' CustomerUpdateById: type: object properties: name: type: string next_price: type: integer format: int64 next_date: type: integer format: int64 periodicity: type: integer format: int64 updated_by: type: integer format: int64 updated_at: type: integer format: int64 status_id: type: integer format: int64 responsible_user_id: type: integer format: int64 main_user_id: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' tags_to_add: type: array items: $ref: '#/components/schemas/Tag' tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' _embedded: type: object properties: tags: anyOf: - type: array items: $ref: '#/components/schemas/Tag' - type: 'null' segments: anyOf: - type: array items: $ref: '#/components/schemas/RefEntity' - type: 'null' CustomerUpdateItem: type: object required: - id properties: id: type: integer format: int64 name: type: string next_price: type: integer format: int64 next_date: type: integer format: int64 periodicity: type: integer format: int64 updated_by: type: integer format: int64 updated_at: type: integer format: int64 status_id: type: integer format: int64 responsible_user_id: type: integer format: int64 main_user_id: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' tags_to_add: type: array items: $ref: '#/components/schemas/Tag' tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' _embedded: type: object properties: tags: anyOf: - type: array items: $ref: '#/components/schemas/Tag' - type: 'null' segments: anyOf: - type: array items: $ref: '#/components/schemas/RefEntity' - type: 'null' CustomerUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: customers: type: array items: $ref: '#/components/schemas/CustomerUpdatedResult' CustomerUpdatedResult: type: object properties: id: type: integer format: int64 updated_at: type: integer format: int64 _links: type: object unevaluatedProperties: {} DateTimeSettings: type: object properties: date_pattern: type: string short_date_pattern: type: string short_time_pattern: type: string date_format: type: string time_format: type: string timezone: type: string timezone_offset: type: string EmptyResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object unevaluatedProperties: {} EntityFollower: type: object properties: id: type: integer format: int64 user_id: type: integer format: int64 created_by: type: integer format: int64 created_at: type: integer format: int64 EntityFollowerCreateItem: type: object required: - user_id properties: user_id: type: integer format: int64 EntityFollowerCreateResponse: type: object properties: _total_items: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: followers: type: array items: $ref: '#/components/schemas/EntityFollowerCreateResult' EntityFollowerCreateResult: type: object properties: user_id: type: integer format: int64 EntityFollowerDeleteItem: type: object required: - user_id properties: user_id: type: integer format: int64 EntityFollowerListResponse: type: object properties: _total_items: type: integer format: int32 _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: followers: type: array items: $ref: '#/components/schemas/EntityFollower' EntityLinkItem: type: object properties: entity_id: type: integer format: int64 entity_type: anyOf: - $ref: '#/components/schemas/EntityLinkType' - type: string to_entity_id: type: integer format: int64 to_entity_type: anyOf: - $ref: '#/components/schemas/EntityLinkType' - type: string metadata: type: object unevaluatedProperties: {} EntityLinkType: type: string enum: - leads - contacts - companies - customers EntityLinksResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: links: type: array items: $ref: '#/components/schemas/EntityLinkItem' Event: type: object properties: id: type: integer format: int64 type: type: string entity_id: type: integer format: int64 entity_type: type: string created_by: type: integer format: int64 created_at: type: integer format: int64 value_before: type: object unevaluatedProperties: {} value_after: type: object unevaluatedProperties: {} _links: type: object unevaluatedProperties: {} EventListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: events: type: array items: $ref: '#/components/schemas/Event' EventTypesResponse: type: object properties: _embedded: type: object properties: types: type: array items: type: object unevaluatedProperties: {} FormMetadata: type: object properties: ip: type: string description: IP address of the submitter form_id: anyOf: - type: string - type: integer format: int64 description: Form id in your system (string or numeric) form_sent_at: type: integer format: int64 description: Unix timestamp (seconds) when the form was submitted form_name: type: string description: Form name (shown in amoCRM) form_page: type: string description: Page URL where form lives referer: type: string description: Referrer URL visitor_uid: type: string description: Visitor uid from tracking, if you have it form_type: type: integer format: int32 description: Form type code from amoCRM, use only if you know it InvoicesSettings: type: object properties: lang: type: string invoices_catalog_id: type: integer format: int64 Lead: type: object properties: id: type: integer format: int64 name: type: string price: type: integer format: int32 responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 status_id: type: integer format: int64 pipeline_id: type: integer format: int64 loss_reason_id: type: integer format: int64 source_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 closed_at: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 closest_task_at: type: integer format: int64 is_deleted: type: boolean custom_fields_values: anyOf: - type: array items: $ref: '#/components/schemas/CustomFieldValue' - type: 'null' score: anyOf: - type: integer format: int32 - type: 'null' account_id: type: integer format: int64 labor_cost: type: integer format: int64 is_price_modified_by_robot: type: boolean visitor_uid: type: string _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/LeadEmbedded' LeadCompanyRef: type: object properties: id: type: integer format: int64 LeadComplexCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: leads: type: array items: $ref: '#/components/schemas/LeadComplexCreateResult' LeadComplexCreateResult: type: object properties: id: type: integer format: int64 contact_id: type: integer format: int64 company_id: type: integer format: int64 merged: type: boolean request_id: type: string LeadContactRef: type: object properties: id: type: integer format: int64 is_main: type: boolean LeadCreate: type: object properties: request_id: type: string description: Client-side request id name: type: string price: type: integer format: int32 responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 status_id: type: integer format: int64 pipeline_id: type: integer format: int64 loss_reason_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 closed_at: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 visitor_uid: type: string description: Website visitor uid from tracking; links this lead to a site visit custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach _embedded: allOf: - $ref: '#/components/schemas/LeadCreateEmbedded' description: Embedded entities (lead/contact/company/source) LeadCreateEmbedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' contacts: type: array items: $ref: '#/components/schemas/ContactCreate' companies: type: array items: $ref: '#/components/schemas/CompanyCreate' metadata: $ref: '#/components/schemas/LeadUnsortedMetadata' source: $ref: '#/components/schemas/LeadSourceRef' LeadCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: leads: type: array items: $ref: '#/components/schemas/LeadCreateResult' LeadCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} LeadEmbedded: type: object properties: loss_reason: $ref: '#/components/schemas/LossReason' tags: type: array items: $ref: '#/components/schemas/Tag' contacts: type: array items: $ref: '#/components/schemas/LeadContactRef' companies: type: array items: $ref: '#/components/schemas/LeadCompanyRef' catalog_elements: type: array items: $ref: '#/components/schemas/CatalogElementRef' source: $ref: '#/components/schemas/LeadSourceRef' LeadListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: leads: type: array items: $ref: '#/components/schemas/Lead' LeadSourceRef: type: object properties: external_id: anyOf: - type: string - type: integer format: int32 - type: boolean description: External id in your system type: type: string description: Source type LeadUnsortedMetadata: type: object properties: category: type: string enum: - sip - forms - chats - mail description: Unsorted category ip: type: string description: IP address of the submitter form_id: anyOf: - type: string - type: integer format: int64 description: Form id in your system (string or numeric) form_sent_at: type: integer format: int64 description: Unix timestamp (seconds) when the form was submitted form_name: type: string description: Form name (shown in amoCRM) form_page: type: string description: Page URL where form lives referer: type: string description: Referrer URL visitor_uid: type: string description: Visitor uid from tracking, if you have it form_type: type: integer format: int32 description: Form type code from amoCRM, use only if you know it LeadUpdateById: type: object properties: name: type: string price: type: integer format: int32 responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 status_id: type: integer format: int64 pipeline_id: type: integer format: int64 loss_reason_id: type: integer format: int64 closed_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' description: Tags to delete _embedded: $ref: '#/components/schemas/LeadCreateEmbedded' LeadUpdateItem: type: object required: - id properties: id: type: integer format: int64 description: Lead id name: type: string price: type: integer format: int32 responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 status_id: type: integer format: int64 pipeline_id: type: integer format: int64 loss_reason_id: type: integer format: int64 closed_at: type: integer format: int64 updated_at: type: integer format: int64 custom_fields_values: type: array items: $ref: '#/components/schemas/CustomFieldValue' description: Custom fields payload tags_to_add: type: array items: $ref: '#/components/schemas/Tag' description: Tags to attach tags_to_delete: type: array items: $ref: '#/components/schemas/Tag' description: Tags to delete _embedded: $ref: '#/components/schemas/LeadCreateEmbedded' LeadUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: leads: type: array items: $ref: '#/components/schemas/LeadUpdatedResult' LeadUpdatedResult: type: object properties: id: type: integer format: int64 updated_at: type: integer format: int64 _links: type: object unevaluatedProperties: {} LossReason: type: object properties: id: type: integer format: int64 name: type: string Note: type: object properties: id: type: integer format: int64 entity_id: type: integer format: int64 note_type: $ref: '#/components/schemas/NoteType' responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 account_id: type: integer format: int64 is_pinned: type: boolean params: $ref: '#/components/schemas/NoteParams' _links: type: object unevaluatedProperties: {} NoteCreate: type: object required: - note_type properties: request_id: type: string description: Client-side request id entity_id: type: integer format: int64 note_type: $ref: '#/components/schemas/NoteType' params: $ref: '#/components/schemas/NoteParams' created_by: type: integer format: int64 responsible_user_id: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 is_need_to_trigger_digital_pipeline: type: boolean NoteCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: notes: type: array items: $ref: '#/components/schemas/NoteCreateResult' NoteCreateResult: type: object properties: id: type: integer format: int64 entity_id: type: integer format: int64 request_id: type: string updated_at: type: integer format: int64 _links: type: object unevaluatedProperties: {} NoteListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: notes: type: array items: $ref: '#/components/schemas/Note' NoteParams: anyOf: - $ref: '#/components/schemas/NoteParamsCall' - $ref: '#/components/schemas/NoteParamsGeolocation' - $ref: '#/components/schemas/NoteParamsAttachment' - $ref: '#/components/schemas/NoteParamsMessageCashier' - $ref: '#/components/schemas/NoteParamsServiceMessage' - $ref: '#/components/schemas/NoteParamsSms' - $ref: '#/components/schemas/NoteParamsCommon' description: |- Параметры примечания: состав зависит от `note_type`. Варианты — от самого специфичного к общему, дискриминатора внутри params нет. NoteParamsAttachment: type: object required: - file_uuid - file_name properties: version_uuid: type: string description: Версия файла; без неё берётся последняя file_uuid: type: string file_name: type: string description: Название файла, которое отображается в примечании description: attachment NoteParamsCall: type: object required: - uniq - duration - source - link - phone - call_responsible properties: uniq: type: string duration: type: integer format: int32 description: Длительность звонка в секундах source: type: string link: type: string description: Ссылка на запись звонка phone: type: string call_responsible: anyOf: - type: string - type: integer format: int64 description: Имя ответственного или ID пользователя description: call_in, call_out NoteParamsCommon: type: object required: - text properties: text: type: string description: common NoteParamsGeolocation: type: object required: - text - address - longitude - latitude properties: text: type: string address: type: string longitude: type: string latitude: type: string description: geolocation NoteParamsMessageCashier: type: object required: - status - text properties: status: type: string enum: - created - shown - canceled text: type: string description: message_cashier NoteParamsServiceMessage: type: object required: - service - text properties: service: type: string text: type: string description: service_message, extended_service_message NoteParamsSms: type: object required: - text - phone properties: text: type: string phone: type: string description: sms_in, sms_out NoteType: type: string enum: - common - call_in - call_out - service_message - message_cashier - geolocation - sms_in - sms_out - extended_service_message - attachment description: Тип примечания. NoteUpdateById: type: object properties: entity_id: type: integer format: int64 note_type: $ref: '#/components/schemas/NoteType' params: $ref: '#/components/schemas/NoteParams' updated_by: type: integer format: int64 updated_at: type: integer format: int64 NoteUpdateByParentId: type: object properties: note_type: $ref: '#/components/schemas/NoteType' params: $ref: '#/components/schemas/NoteParams' updated_by: type: integer format: int64 updated_at: type: integer format: int64 NoteUpdateItem: type: object required: - id properties: id: type: integer format: int64 description: Note id entity_id: type: integer format: int64 note_type: $ref: '#/components/schemas/NoteType' params: $ref: '#/components/schemas/NoteParams' updated_by: type: integer format: int64 updated_at: type: integer format: int64 Pipeline: type: object properties: id: type: integer format: int64 name: type: string sort: type: integer format: int32 account_id: type: integer format: int64 is_main: type: boolean is_unsorted_on: type: boolean is_archive: type: boolean _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/PipelineEmbedded' PipelineCreateEmbedded: type: object properties: statuses: type: array items: $ref: '#/components/schemas/StatusCreateItem' PipelineCreateItem: type: object required: - name properties: name: type: string sort: type: integer format: int32 is_main: type: boolean is_unsorted_on: type: boolean _embedded: $ref: '#/components/schemas/PipelineCreateEmbedded' request_id: type: string PipelineCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: pipelines: type: array items: $ref: '#/components/schemas/PipelineCreateResult' PipelineCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} PipelineEmbedded: type: object properties: statuses: type: array items: $ref: '#/components/schemas/Status' PipelineListResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: pipelines: type: array items: $ref: '#/components/schemas/Pipeline' PipelineUpdateById: type: object properties: name: type: string sort: type: integer format: int32 is_main: type: boolean is_unsorted_on: type: boolean is_archive: type: boolean request_id: type: string PipelineUpdateItem: type: object required: - id properties: id: type: integer format: int64 name: type: string sort: type: integer format: int32 is_main: type: boolean is_unsorted_on: type: boolean is_archive: type: boolean request_id: type: string PipelineUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: pipelines: type: array items: $ref: '#/components/schemas/PipelineUpdatedResult' PipelineUpdatedResult: type: object properties: id: type: integer format: int64 updated_at: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} ProblemDetails: type: object properties: title: type: string status: type: integer format: int32 detail: type: string type: type: string RefEntity: type: object properties: id: type: integer format: int64 _links: type: object unevaluatedProperties: {} Role: type: object properties: id: type: integer format: int64 name: type: string rights: $ref: '#/components/schemas/UserRights' _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/RoleEmbedded' RoleCreateItem: type: object required: - name properties: name: type: string rights: $ref: '#/components/schemas/UserRights' request_id: type: string RoleCreateResponse: type: object properties: _total_items: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: roles: type: array items: $ref: '#/components/schemas/RoleCreateResult' RoleCreateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/Role' RoleEmbedded: type: object properties: users: type: array items: type: object properties: id: type: integer format: int64 RoleListResponse: type: object properties: _total_items: type: integer format: int32 _page: type: integer format: int32 _page_count: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: roles: type: array items: $ref: '#/components/schemas/Role' RoleUpdateById: type: object properties: name: type: string rights: anyOf: - $ref: '#/components/schemas/UserRights' - type: 'null' request_id: type: string SalesbotRunItem: type: object required: - bot_id - entity_id - entity_type properties: bot_id: type: integer format: int64 entity_id: type: integer format: int64 entity_type: type: integer format: int32 SalesbotRunResponse: type: object properties: success: type: boolean _links: type: object properties: self: type: object properties: href: type: string method: type: string ShortLinkCreateRequest: type: object required: - url properties: url: type: string ShortLinkCreateResponse: type: object properties: short_link: type: string Source: type: object properties: id: type: integer format: int64 name: type: string pipeline_id: anyOf: - type: integer format: int64 - type: 'null' external_id: anyOf: - type: string - type: integer format: int64 - type: boolean default: type: boolean origin_code: anyOf: - type: string - type: 'null' services: anyOf: - type: array items: type: object unevaluatedProperties: {} - type: array items: type: string _links: type: object unevaluatedProperties: {} SourceCreateItem: type: object required: - name - external_id properties: name: type: string pipeline_id: anyOf: - type: integer format: int64 - type: 'null' external_id: type: string default: type: boolean origin_code: anyOf: - type: string - type: 'null' services: anyOf: - type: array items: type: object unevaluatedProperties: {} - type: array items: type: string request_id: type: string SourceCreateResponse: type: object properties: _total_items: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: sources: type: array items: $ref: '#/components/schemas/SourceCreateResult' SourceCreateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/Source' SourceDeleteItem: type: object required: - id properties: id: type: integer format: int64 SourceListResponse: type: object properties: _total_items: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: sources: type: array items: $ref: '#/components/schemas/Source' SourceUpdateById: type: object properties: name: type: string pipeline_id: anyOf: - type: integer format: int64 - type: 'null' external_id: type: string default: type: boolean origin_code: anyOf: - type: string - type: 'null' services: anyOf: - type: array items: type: object unevaluatedProperties: {} - type: array items: type: string request_id: type: string SourceUpdateItem: type: object required: - id properties: id: type: integer format: int64 name: type: string pipeline_id: anyOf: - type: integer format: int64 - type: 'null' external_id: type: string default: type: boolean origin_code: anyOf: - type: string - type: 'null' services: anyOf: - type: array items: type: object unevaluatedProperties: {} - type: array items: type: string request_id: type: string SourceUpdateResponse: type: object properties: _total_items: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: sources: type: array items: $ref: '#/components/schemas/SourceUpdateResult' SourceUpdateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/Source' Status: type: object properties: id: type: integer format: int64 name: type: string sort: type: integer format: int32 account_id: type: integer format: int64 is_editable: type: boolean color: type: string type: type: integer format: int32 pipeline_id: type: integer format: int64 descriptions: anyOf: - type: array items: $ref: '#/components/schemas/StatusDescription' - type: 'null' StatusCreateItem: type: object required: - name properties: name: type: string sort: type: integer format: int32 color: type: string descriptions: type: array items: $ref: '#/components/schemas/StatusDescriptionPayload' request_id: type: string StatusCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: statuses: type: array items: $ref: '#/components/schemas/StatusCreateResult' StatusCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} StatusDescription: type: object properties: id: type: integer format: int64 account_id: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 pipeline_id: type: integer format: int64 status_id: type: integer format: int64 level: type: string description: type: string StatusDescriptionPayload: type: object properties: id: type: integer format: int64 level: type: string description: type: string StatusListResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: statuses: type: array items: $ref: '#/components/schemas/Status' StatusRight: type: object properties: entity_type: type: string pipeline_id: type: integer format: int64 status_id: type: integer format: int64 rights: type: object unevaluatedProperties: {} StatusUpdateById: type: object properties: name: type: string sort: type: integer format: int32 color: type: string descriptions: type: array items: $ref: '#/components/schemas/StatusDescriptionPayload' request_id: type: string StatusUpdateItem: type: object required: - id properties: id: type: integer format: int64 name: type: string sort: type: integer format: int32 color: type: string descriptions: type: array items: $ref: '#/components/schemas/StatusDescriptionPayload' request_id: type: string StatusUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: statuses: type: array items: $ref: '#/components/schemas/StatusUpdatedResult' StatusUpdatedResult: type: object properties: id: type: integer format: int64 updated_at: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} Tag: type: object properties: id: type: integer format: int64 name: type: string color: type: string TagCreate: type: object required: - name properties: name: type: string color: type: string request_id: type: string TagCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/TagCreateResult' TagCreateResult: type: object properties: id: type: integer format: int64 name: type: string color: type: string request_id: type: string TagListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' Talk: type: object properties: talk_id: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 rate: type: integer format: int32 contact_id: type: integer format: int64 chat_id: type: string entity_id: anyOf: - type: integer format: int64 - type: 'null' entity_type: anyOf: - type: string - type: 'null' is_in_work: type: boolean is_read: type: boolean origin: type: string missed_at: anyOf: - type: integer format: int64 - type: 'null' account_id: type: integer format: int64 _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/TalkEmbedded' TalkCloseRequest: type: object properties: force_close: type: boolean description: Force close talk without NPS bot. TalkEmbedded: type: object properties: contacts: type: array items: $ref: '#/components/schemas/RefEntity' leads: type: array items: $ref: '#/components/schemas/RefEntity' customers: type: array items: $ref: '#/components/schemas/RefEntity' Task: type: object properties: id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 created_at: type: integer format: int64 updated_at: type: integer format: int64 responsible_user_id: type: integer format: int64 group_id: type: integer format: int64 entity_id: type: integer format: int64 entity_type: type: string duration: type: integer format: int64 is_completed: type: boolean task_type_id: type: integer format: int64 text: type: string result: anyOf: - type: object properties: text: type: string - type: object unevaluatedProperties: {} complete_till: type: integer format: int64 account_id: type: integer format: int64 _links: type: object unevaluatedProperties: {} TaskCreate: type: object required: - text properties: request_id: type: string description: Client-side request id task_type_id: type: integer format: int64 text: type: string complete_till: type: integer format: int64 entity_id: type: integer format: int64 entity_type: type: string responsible_user_id: type: integer format: int64 created_by: type: integer format: int64 updated_by: type: integer format: int64 TaskCreateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: tasks: type: array items: $ref: '#/components/schemas/TaskCreateResult' TaskCreateResult: type: object properties: id: type: integer format: int64 request_id: type: string _links: type: object unevaluatedProperties: {} TaskListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: tasks: type: array items: $ref: '#/components/schemas/Task' TaskType: type: object properties: id: type: integer format: int64 name: type: string color: type: string icon_id: type: integer format: int64 code: type: string TaskUpdateById: type: object properties: task_type_id: type: integer format: int64 text: type: string complete_till: type: integer format: int64 entity_id: type: integer format: int64 entity_type: type: string responsible_user_id: type: integer format: int64 is_completed: type: boolean result: type: object properties: text: type: string TaskUpdateItem: type: object required: - id properties: id: type: integer format: int64 description: Task id task_type_id: type: integer format: int64 text: type: string complete_till: type: integer format: int64 entity_id: type: integer format: int64 entity_type: type: string responsible_user_id: type: integer format: int64 is_completed: type: boolean result: type: object properties: text: type: string TaskUpdateResponse: type: object properties: _links: type: object unevaluatedProperties: {} _embedded: type: object properties: tasks: type: array items: $ref: '#/components/schemas/TaskUpdatedResult' TaskUpdatedResult: type: object properties: id: type: integer format: int64 updated_at: type: integer format: int64 _links: type: object unevaluatedProperties: {} UnsortedAcceptRequest: type: object properties: user_id: type: integer format: int64 description: User id on whose behalf the item is accepted status_id: type: integer format: int64 description: Status id for the created lead UnsortedAcceptResponse: type: object properties: uid: type: string pipeline_id: type: integer format: int64 category: type: string enum: - sip - mail - chats - forms created_at: type: integer format: int64 _embedded: $ref: '#/components/schemas/UnsortedCreatedEmbedded' UnsortedCreateResponse: type: object properties: _total_items: type: integer format: int32 _embedded: type: object properties: unsorted: type: array items: $ref: '#/components/schemas/UnsortedCreatedItem' UnsortedCreatedEmbedded: type: object properties: leads: type: array items: $ref: '#/components/schemas/RefEntity' contacts: type: array items: $ref: '#/components/schemas/RefEntity' companies: type: array items: $ref: '#/components/schemas/RefEntity' UnsortedCreatedItem: type: object properties: uid: type: string account_id: type: integer format: int64 request_id: type: string description: Echoed request id _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/UnsortedCreatedEmbedded' UnsortedDeclineRequest: type: object properties: user_id: type: integer format: int64 description: User id on whose behalf the item is declined UnsortedEmbeddedCreate: type: object properties: leads: type: array items: $ref: '#/components/schemas/LeadCreate' description: Create related entities together with unsorted (lead/contact/company) contacts: type: array items: $ref: '#/components/schemas/ContactCreate' companies: type: array items: $ref: '#/components/schemas/CompanyCreate' UnsortedFormCreateItem: type: object required: - source_uid - source_name - metadata properties: request_id: type: string description: Your request id to match request items with response items source_uid: type: string description: 'Your stable id of the source: site/form/widget/integration that sent the lead' source_name: type: string description: Human-readable source name shown in amoCRM (e.g. "Website form", "Landing page") pipeline_id: type: integer format: int64 description: Pipeline id to place the created lead into created_at: type: integer format: int64 description: Unix timestamp (seconds) when the form entry was created _embedded: allOf: - $ref: '#/components/schemas/UnsortedEmbeddedCreate' description: Embedded entities (lead/contact/company) metadata: allOf: - $ref: '#/components/schemas/FormMetadata' description: Form metadata User: type: object properties: id: type: integer format: int64 name: type: string email: type: string lang: type: string rights: $ref: '#/components/schemas/UserRights' uuid: anyOf: - type: string - type: 'null' amojo_id: anyOf: - type: string - type: 'null' user_rank: anyOf: - type: string - type: 'null' phone_number: anyOf: - type: string - type: 'null' _links: type: object unevaluatedProperties: {} _embedded: $ref: '#/components/schemas/UserEmbedded' UserCreateItem: type: object required: - name - email - password properties: name: type: string email: type: string password: type: string lang: type: string rights: $ref: '#/components/schemas/UserRights' request_id: type: string UserCreateResponse: type: object properties: _total_items: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: users: type: array items: $ref: '#/components/schemas/UserCreateResult' UserCreateResult: type: object properties: request_id: type: string allOf: - $ref: '#/components/schemas/User' UserEmbedded: type: object properties: roles: type: array items: $ref: '#/components/schemas/Role' groups: type: array items: $ref: '#/components/schemas/UsersGroup' UserListResponse: type: object properties: _total_items: type: integer format: int32 _page: type: integer format: int32 _page_count: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: users: type: array items: $ref: '#/components/schemas/User' UserRights: type: object properties: leads: type: object unevaluatedProperties: {} contacts: type: object unevaluatedProperties: {} companies: type: object unevaluatedProperties: {} tasks: type: object unevaluatedProperties: {} mail_access: type: boolean catalog_access: type: boolean is_admin: type: boolean is_free: type: boolean is_active: type: boolean group_id: anyOf: - type: integer format: int64 - type: 'null' role_id: anyOf: - type: integer format: int64 - type: 'null' status_rights: anyOf: - type: array items: $ref: '#/components/schemas/StatusRight' - type: 'null' UsersGroup: type: object properties: id: type: integer format: int64 name: type: string uuid: type: string Webhook: type: object properties: id: type: integer format: int64 destination: type: string created_at: type: integer format: int64 updated_at: type: integer format: int64 account_id: type: integer format: int64 created_by: type: integer format: int64 sort: type: integer format: int32 disabled: type: boolean settings: type: array items: type: string WebhookListResponse: type: object properties: _total_items: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/Webhook' WebhookSubscribeRequest: type: object required: - destination - settings properties: destination: type: string settings: type: array items: type: string sort: type: integer format: int32 WebhookUnsubscribeRequest: type: object required: - destination properties: destination: type: string WebsiteButton: type: object properties: account_id: type: integer format: int64 source_id: type: integer format: int64 button_id: type: integer format: int64 is_duplication_control_enabled: type: boolean name: type: string creation_status: type: string pipeline_id: anyOf: - type: integer format: int64 - type: 'null' script: anyOf: - type: string - type: 'null' WebsiteButtonCreateRequest: type: object required: - pipeline_id properties: pipeline_id: type: integer format: int64 trusted_websites: type: array items: type: string is_used_in_app: type: boolean WebsiteButtonCreateResponse: type: object properties: source_id: type: integer format: int64 trusted_websites: type: array items: type: string WebsiteButtonListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: website_buttons: type: array items: $ref: '#/components/schemas/WebsiteButton' WebsiteButtonUpdateRequest: type: object required: - trusted_websites properties: trusted_websites: type: object properties: add: type: array items: type: string required: - add Widget: type: object properties: id: type: integer format: int64 code: type: string version: anyOf: - type: string - type: integer format: int32 - type: 'null' rating: anyOf: - type: string - type: number format: double - type: 'null' settings_template: type: array items: $ref: '#/components/schemas/WidgetSettingTemplate' is_lead_source: type: boolean is_work_with_dp: type: boolean is_crm_template: type: boolean client_uuid: anyOf: - type: string - type: 'null' is_active_in_account: type: boolean pipeline_id: anyOf: - type: integer format: int64 - type: 'null' settings: anyOf: - type: object unevaluatedProperties: {} - type: 'null' _links: type: object unevaluatedProperties: {} WidgetContinueRequest: type: object properties: data: type: object unevaluatedProperties: {} execute_handlers: type: array items: $ref: '#/components/schemas/WidgetExecuteHandler' WidgetExecuteHandler: type: object properties: handler: type: string params: type: object unevaluatedProperties: {} WidgetListResponse: type: object properties: _page: type: integer format: int32 _links: type: object unevaluatedProperties: {} _embedded: type: object properties: widgets: type: array items: $ref: '#/components/schemas/Widget' WidgetSettingTemplate: type: object properties: key: type: string name: type: string type: type: string is_required: type: boolean securitySchemes: BearerAuth: type: http scheme: Bearer servers: - url: https://{subdomain}.amocrm.ru description: amoCRM account server variables: subdomain: default: ''