Sendoso Sending Platform API — Recipients

naftiko: 1.0.0-alpha2
info:
  label: Sendoso Sending Platform API — Recipients
  description: 'Sendoso Sending Platform API — Recipients. 3 operations. Lead operation: List Recipients. Self-contained Naftiko
    capability covering one Sendoso business surface.'
  tags:
  - Sendoso
  - Recipients
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SENDOSO_API_KEY: SENDOSO_API_KEY
capability:
  consumes:
  - type: http
    namespace: sendoso-recipients
    baseUri: https://app.sendoso.com/api/v2
    description: Sendoso Sending Platform API — Recipients business capability. Self-contained, no shared references.
    resources:
    - name: recipients
      path: /recipients
      operations:
      - name: listrecipients
        method: GET
        description: List Recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: per_page
          in: query
          type: integer
        - name: search
          in: query
          type: string
          description: Search by name or email
      - name: createrecipient
        method: POST
        description: Create Recipient
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: recipients-recipient_id
      path: /recipients/{recipient_id}
      operations:
      - name: retrieverecipient
        method: GET
        description: Retrieve Recipient
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-Api-Key
      value: '{{env.SENDOSO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: sendoso-recipients-rest
    port: 8080
    description: REST adapter for Sendoso Sending Platform API — Recipients. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/recipients
      name: recipients
      description: REST surface for recipients.
      operations:
      - method: GET
        name: listrecipients
        description: List Recipients
        call: sendoso-recipients.listrecipients
        with:
          page: rest.page
          per_page: rest.per_page
          search: rest.search
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrecipient
        description: Create Recipient
        call: sendoso-recipients.createrecipient
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/recipients/{recipient-id}
      name: recipients-recipient-id
      description: REST surface for recipients-recipient_id.
      operations:
      - method: GET
        name: retrieverecipient
        description: Retrieve Recipient
        call: sendoso-recipients.retrieverecipient
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sendoso-recipients-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sendoso Sending Platform API — Recipients. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-recipients
      description: List Recipients
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendoso-recipients.listrecipients
      with:
        page: tools.page
        per_page: tools.per_page
        search: tools.search
      outputParameters:
      - type: object
        mapping: $.
    - name: create-recipient
      description: Create Recipient
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sendoso-recipients.createrecipient
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-recipient
      description: Retrieve Recipient
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendoso-recipients.retrieverecipient
      outputParameters:
      - type: object
        mapping: $.