Merge

Merge subpackage_toolDescriptionOverrides API

The subpackage_toolDescriptionOverrides API from Merge — 2 operation(s) for subpackage_tooldescriptionoverrides.

Documentation GitHub OpenAPI

Documentation

https://docs.merge.dev/merge-unified/hris/overview

https://docs.merge.dev/merge-unified/ats/overview

https://docs.merge.dev/merge-unified/accounting/overview

https://docs.merge.dev/merge-unified/ticketing/overview

https://docs.merge.dev/merge-unified/crm/overview

https://docs.merge.dev/merge-unified/filestorage/overview

https://docs.merge.dev/merge-unified/knowledge-base/overview

https://docs.merge.dev/merge-unified/chat/overview

https://docs.merge.dev/merge-agent-handler/agent-handler

https://docs.merge.dev/merge-gateway/api-overview

Specifications

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/openapi/merge-subpackage-tooldescriptionoverrides-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/hris-api-employee-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/hris-api-employee-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/ats-api-candidate-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/ats-api-application-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/ats-api-candidate-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/accounting-api-invoice-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/accounting-api-invoice-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/ticketing-api-ticket-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/ticketing-api-ticket-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/crm-api-opportunity-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/crm-api-opportunity-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/file-storage-api-file-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/file-storage-api-file-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/knowledge-base-api-article-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/knowledge-base-api-article-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/chat-api-message-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/chat-api-message-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/agent-handler-tool-pack-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/agent-handler-tool-pack-structure.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/gateway-response-schema.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/gateway-response-structure.json

Other Resources

https://www.merge.dev/categories/hr-payroll-api

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-hris-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/hris-api-employee-example.json

https://www.merge.dev/categories/ats-recruiting-api

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-ats-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/ats-api-candidate-example.json

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/ats-api-application-example.json

https://www.merge.dev/categories/accounting-api

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-accounting-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/accounting-api-invoice-example.json

https://www.merge.dev/categories/ticketing-api

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-ticketing-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/ticketing-api-ticket-example.json

https://www.merge.dev/categories/crm-api

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-crm-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/crm-api-opportunity-example.json

https://www.merge.dev/categories/file-storage-api

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-file-storage-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/file-storage-api-file-example.json

https://www.merge.dev/categories/knowledge-base

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-knowledge-base-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/knowledge-base-api-article-example.json

https://www.merge.dev/categories/chat

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-chat-api-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/chat-api-message-example.json

https://www.merge.dev/merge-agent-handler

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-agent-handler-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/agent-handler-tool-pack-example.json

https://help.ah.merge.dev/

https://www.merge.dev/gateway

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-ld/merge-gateway-context.jsonld

https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/examples/gateway-response-example.json

OpenAPI Specification

openapi: 3.1.0
info:
  title: Accounting subpackage_toolDescriptionOverrides API
  version: 1.0.0
servers:
- url: https://api.merge.dev/api
- url: https://api-eu.merge.dev/api
- url: https://api-ap.merge.dev/api
tags:
- name: subpackage_toolDescriptionOverrides
paths:
  /api/v1/connectors/tool-description-overrides/:
    get:
      operationId: list
      summary: List tool description overrides (connector)
      description: List tool description overrides, optionally filtered by connector slug. Returns paginated results.
      tags:
      - subpackage_toolDescriptionOverrides
      parameters:
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: slug
        in: query
        description: Filter by connector slug.
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedToolDescriptionOverrideList'
    patch:
      operationId: bulk-upsert-delete
      summary: Bulk upsert/delete tool description overrides (connector)
      description: Bulk upsert or delete tool description overrides. Send a list of items with connector_slug, tool_name, and description. Set description to null to delete an override.
      tags:
      - subpackage_toolDescriptionOverrides
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ToolDescriptionOverride'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkToolDescriptionOverrideInput'
  /api/v1/tool-packs/{tool_pack_id}/tool-description-overrides/:
    get:
      operationId: list-tool-pack
      summary: List tool description overrides (Tool Pack)
      description: List tool-pack-level description overrides, optionally filtered by connector slug. Returns paginated results.
      tags:
      - subpackage_toolDescriptionOverrides
      parameters:
      - name: tool_pack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: slug
        in: query
        description: Filter by connector slug.
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedToolPackToolDescriptionOverrideList'
    patch:
      operationId: bulk-upsert-delete-tool-pack
      summary: Bulk upsert/delete tool description overrides (Tool Pack)
      description: Bulk upsert or delete tool-pack-level description overrides. Send a list of items with connector_slug, tool_name, and description. Set description to null to delete an override.
      tags:
      - subpackage_toolDescriptionOverrides
      parameters:
      - name: tool_pack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ToolDescriptionOverride'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkToolDescriptionOverrideInput'
components:
  schemas:
    PaginatedToolPackToolDescriptionOverrideList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
        results:
          type: array
          items:
            $ref: '#/components/schemas/ToolDescriptionOverride'
      required:
      - count
      - next
      - previous
      - results
      title: PaginatedToolPackToolDescriptionOverrideList
    PaginatedToolDescriptionOverrideList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
        results:
          type: array
          items:
            $ref: '#/components/schemas/ToolDescriptionOverride'
      required:
      - count
      - next
      - previous
      - results
      title: PaginatedToolDescriptionOverrideList
    ToolDescriptionOverride:
      type: object
      properties:
        id:
          type: string
          format: uuid
        connector_slug:
          type: string
        tool_name:
          type: string
          description: Name of the tool being overridden
        description:
          type: string
          description: Custom description for the tool
        defined_at:
          type: string
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
      required:
      - id
      - connector_slug
      - tool_name
      - description
      - defined_at
      - created_at
      - modified_at
      description: 'Response serializer for tool-level description overrides.


        Includes a computed `defined_at` field (CONNECTOR or TOOL_PACK) indicating

        whether the override originates from the connector level or tool pack level.'
      title: ToolDescriptionOverride
    BulkToolDescriptionOverrideInput:
      type: object
      properties:
        connector_slug:
          type: string
        tool_name:
          type: string
        description:
          type:
          - string
          - 'null'
      required:
      - connector_slug
      - tool_name
      - description
      description: Input serializer for each item in a bulk PATCH request.
      title: BulkToolDescriptionOverrideInput
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      description: Token-based authentication with required prefix "Bearer"