Freshworks Freshsales API — Notes

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshsales API — Notes
  description: 'Freshworks Freshsales API — Notes. 2 operations. Lead operation: Create a note. Self-contained Naftiko capability
    covering one Freshworks business surface.'
  tags:
  - Freshworks
  - Notes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHWORKS_API_KEY: FRESHWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: freshsales-notes
    baseUri: https://{domain}.myfreshworks.com/crm/sales/api
    description: Freshworks Freshsales API — Notes business capability. Self-contained, no shared references.
    resources:
    - name: notes
      path: /notes
      operations:
      - name: createnote
        method: POST
        description: Create a note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: notes-note_id
      path: /notes/{note_id}
      operations:
      - name: deletenote
        method: DELETE
        description: Delete a note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: note_id
          in: path
          type: integer
          description: The ID of the note.
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.FRESHWORKS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: freshsales-notes-rest
    port: 8080
    description: REST adapter for Freshworks Freshsales API — Notes. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/notes
      name: notes
      description: REST surface for notes.
      operations:
      - method: POST
        name: createnote
        description: Create a note
        call: freshsales-notes.createnote
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notes/{note-id}
      name: notes-note-id
      description: REST surface for notes-note_id.
      operations:
      - method: DELETE
        name: deletenote
        description: Delete a note
        call: freshsales-notes.deletenote
        with:
          note_id: rest.note_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshsales-notes-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshsales API — Notes. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-note
      description: Create a note
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshsales-notes.createnote
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-note
      description: Delete a note
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: freshsales-notes.deletenote
      with:
        note_id: tools.note_id
      outputParameters:
      - type: object
        mapping: $.