Copper Developer API — Leads

naftiko: 1.0.0-alpha2
info:
  label: Copper Developer API — Leads
  description: 'Copper Developer API — Leads. 6 operations. Lead operation: Create a Lead. Self-contained Naftiko capability
    covering one Copper business surface.'
  tags:
  - Copper
  - Leads
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COPPER_API_KEY: COPPER_API_KEY
capability:
  consumes:
  - type: http
    namespace: developer-leads
    baseUri: https://api.copper.com/developer_api/v1
    description: Copper Developer API — Leads business capability. Self-contained, no shared references.
    resources:
    - name: leads
      path: /leads
      operations:
      - name: createlead
        method: POST
        description: Create a Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: leads-search
      path: /leads/search
      operations:
      - name: searchleads
        method: POST
        description: Search Leads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: leads-id
      path: /leads/{id}
      operations:
      - name: getlead
        method: GET
        description: Get a Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatelead
        method: PUT
        description: Update a Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletelead
        method: DELETE
        description: Delete a Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: leads-id-convert
      path: /leads/{id}/convert
      operations:
      - name: convertlead
        method: POST
        description: Convert a Lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-PW-AccessToken
      value: '{{env.COPPER_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: developer-leads-rest
    port: 8080
    description: REST adapter for Copper Developer API — Leads. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/leads
      name: leads
      description: REST surface for leads.
      operations:
      - method: POST
        name: createlead
        description: Create a Lead
        call: developer-leads.createlead
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/leads/search
      name: leads-search
      description: REST surface for leads-search.
      operations:
      - method: POST
        name: searchleads
        description: Search Leads
        call: developer-leads.searchleads
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/leads/{id}
      name: leads-id
      description: REST surface for leads-id.
      operations:
      - method: GET
        name: getlead
        description: Get a Lead
        call: developer-leads.getlead
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatelead
        description: Update a Lead
        call: developer-leads.updatelead
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletelead
        description: Delete a Lead
        call: developer-leads.deletelead
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/leads/{id}/convert
      name: leads-id-convert
      description: REST surface for leads-id-convert.
      operations:
      - method: POST
        name: convertlead
        description: Convert a Lead
        call: developer-leads.convertlead
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: developer-leads-mcp
    port: 9090
    transport: http
    description: MCP adapter for Copper Developer API — Leads. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-lead
      description: Create a Lead
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: developer-leads.createlead
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-leads
      description: Search Leads
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: developer-leads.searchleads
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-lead
      description: Get a Lead
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: developer-leads.getlead
      outputParameters:
      - type: object
        mapping: $.
    - name: update-lead
      description: Update a Lead
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: developer-leads.updatelead
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-lead
      description: Delete a Lead
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: developer-leads.deletelead
      outputParameters:
      - type: object
        mapping: $.
    - name: convert-lead
      description: Convert a Lead
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: developer-leads.convertlead
      outputParameters:
      - type: object
        mapping: $.