How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Knock

Knock Guides API

The Guides API from Knock — 8 operation(s) for guides.

Documentation Provider Profile APIs.io OpenAPI GitHub

Knock Guides API is one of 16 APIs that Knock publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

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

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

Requests are made against a single base URL, https://api.knock.app.

9 operations 8 paths 3 schemas 1 DELETE1 GET7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.knock.app/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Knock Guides API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 1 GET, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Guides 9
PUT
/v1/users/{user_id}/guides/messages/seen
Mark guide as seen
markUserGuideAsSeen (2) 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/{message_id}/seen
Mark guide as seen
markUserGuideAsSeen 1 param body → 200
DELETE
/v1/users/{user_id}/guides/messages/archived
Mark guide as unarchived
markUserGuideAsUnarchived 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/archived
Mark guide as archived
markUserGuideAsArchived (2) 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/interacted
Mark guide as interacted
markUserGuideAsInteracted (2) 1 param body → 200
PUT
/v1/users/{user_id}/guides/engagements/reset
Reset guide engagement
resetUserGuideEngagement 1 param body → 200
GET
/v1/users/{user_id}/guides/{channel_id}
List guides
listUserGuides 5 params → 200
PUT
/v1/users/{user_id}/guides/messages/{message_id}/interacted
Mark guide as interacted
markUserGuideAsInteracted 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/{message_id}/archived
Mark guide as archived
markUserGuideAsArchived 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are GuideActionRequest (9 properties), GuidesResponse (4 properties), GuideActionResponse (1 property). Each schema is shown below with its type and property counts.

GuideActionRequest
object
A request to trigger a guide action.
9 properties 4 required
GuideActionResponse
object
A response for a guide action.
1 property 1 required
GuidesResponse
object
A response for a list of guides.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-guides-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
AE Profile APIs.io
Knock Bulk operations API
AE Profile APIs.io
Knock Channel data API
AE Profile APIs.io
Knock Feeds API
AE Profile APIs.io
Knock Integrations API
AE Profile APIs.io
Knock Messages API
AE Profile APIs.io
Knock Objects API
AE Profile APIs.io
Knock Providers API
AE Profile APIs.io
Knock Schedules API
AE Profile APIs.io
Knock Subscriptions API
AE Profile APIs.io
Knock Tenants API
AE Profile APIs.io
Knock Users API
AE Profile APIs.io
#Guides
← Back to K APIs
API Details
ID
knock:knock-guides-api
Base URL
https://api.knock.app/v1
Docs
https://docs.knock.app/reference
Provider
Knock
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=knock-guides-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/knock-guides-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Knock Guides API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.