Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kno2 Messaging API

SEND surface - draft, populate, attach, and send messages.

Kno2 Messaging API is one of 7 APIs that Kno2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Messaging. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://{subscription}.kno2fy.com, https://{subscription}.kno2-stage.com.

3 operations 3 paths 3 schemas 1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://{subscription}.kno2fy.com
Authentication
HTTP Bearer, HTTP Basic
Contact
Resource Areas
1

Authentication & Security 2

Kno2 Messaging API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer access token obtained from POST /api/token.
  • basicAuth — HTTP Basic with base64(clientid:clientsecret), used only against /api/token to obtain a Bearer token.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Messaging 3

SEND surface - draft, populate, attach, and send messages.

PUT
/api/messages
Request a new draft message
createMessageDraft → 200401
PUT
/api/messages/{id}
Populate / update a draft message
updateMessageDraft 1 param body → 200401
POST
/api/messages/{id}/send
Send a message
sendMessage 1 param body → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Message (8 properties), Patient (5 properties), Attachment (5 properties). Each schema is shown below with its type and property counts.

Attachment
object
MODELED - a clinical document attachment.
5 properties
Patient
object
MODELED - patient demographics attached to a message.
5 properties
Message
object
MODELED - a Kno2 message resource. Field set simplified from the ApiTestClient MessageResource and product docs; the authoritative schema is provisioned per pa…
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kno2-messaging-api-openapi.yml Raw ↑

Other APIs Kno2 publishes across the network.

Kno2 FHIR API
Kno2 Patient Record Query API
Kno2 Attachments API
Kno2 Authentication API
Kno2 Directory API
Kno2 Intake API