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

Guides let you define in-app guides that can be displayed to users based on priority and other conditions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Knock Guides API is one of 35 APIs that Knock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

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

This API exposes 15 operations across 12 paths, and defines 13 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.

15 operations 12 paths 13 schemas 2 DELETE3 GET10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Server
https://api.knock.app
Authentication
HTTP Bearer
Contact
Knock
License
Proprietary
Resource Areas
1

Authentication & Security 1

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

  • BearerAuth — Knock API key as a Bearer token. Use a public key (pk...) for client-side requests or a secret key (sk...) for server-side.

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 2 DELETE, 3 GET, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Guides 15

Guides let you define in-app guides that can be displayed to users based on priority and other conditions.

DELETE
/v1/guides/{guide_key}
Archive a guide
archiveGuide 1 param → 200
GET
/v1/guides/{guide_key}
Get a guide
getGuide 5 params → 200
PUT
/v1/guides/{guide_key}
Upsert a guide
upsertGuide 7 params body → 200
GET
/v1/guides
List guides
listGuides 7 params → 200
PUT
/v1/guides/{guide_key}/activate
Activate a guide
activateGuide 3 params body → 200
PUT
/v1/guides/{guide_key}/validate
Validate a guide
validateGuide 3 params body → 200
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 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Guide (18 properties), GuideActionRequest (9 properties), GuideRequest (9 properties), GuideStep (6 properties). Each schema is shown below with its type and property counts.

GuideActionRequest
object
A request to trigger a guide action.
9 properties 4 required
Guide
object
A guide defines an in-app guide that can be displayed to users based on priority and other conditions.
18 properties 7 required
ConditionGroupAnyMatch
object
A group of conditions that any must be met. Can contain nested alls.
1 property
Condition
object
A condition to be evaluated.
3 properties 2 required
PageInfo
object
The information about a paginated result.
3 properties 1 required
ConditionGroup
object
A group of conditions to be evaluated.
GuideRequest
object
A request to create or update a guide.
9 properties 3 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
GuideActivationParams
object
A request to activate or schedule the activation of a guide.
ConditionGroupAllMatch
object
A group of conditions that must all be met.
1 property
GuideActivationUrlPattern
object
A rule that controls when a guide should be shown based on the user's location in the application. At least one of pathname or search must be provided.
3 properties 1 required
GuideStep
object
A step in a guide that corresponds to a piece of UI and its content.
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-guides-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Outbound Webhooks
AE Profile APIs.io
Knock Accounts API
AE Profile APIs.io
Knock API keys API
AE Profile APIs.io
Knock Audiences API
AE Profile APIs.io
Knock Branches API
AE Profile APIs.io
Knock Broadcasts API
AE Profile APIs.io
Knock Bulk operations API
AE Profile APIs.io
Knock Channel data API
AE Profile APIs.io
Knock Channel Groups API
AE Profile APIs.io
Knock Channels API
AE Profile APIs.io
Knock Commits API
AE Profile APIs.io
Knock Email layouts API
AE Profile APIs.io
#Guides
← Back to K APIs
API Details
ID
knock-app:knock-app-guides-api
Server
https://api.knock.app
Docs
https://docs.knock.app/api-reference/workflows
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-app-guides-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/knock-app-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.