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

Knock Partials API

Partials allow you to reuse content across templates.

Knock Partials 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 Partials. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

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

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

4 operations 3 paths 13 schemas 2 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Knock Partials 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 4

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

Partials 4

Partials allow you to reuse content across templates.

GET
/v1/partials
List partials
listPartials 7 params → 200
GET
/v1/partials/{partial_key}
Get a partial
getPartial 5 params → 200
PUT
/v1/partials/{partial_key}
Upsert a partial
upsertPartial 7 params body → 200
PUT
/v1/partials/{partial_key}/validate
Validate a partial
validatePartial 3 params body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Partial (12 properties), MessageTypeImageField (7 properties), PartialRequest (7 properties), MessageTypeButtonField (6 properties). Each schema is shown below with its type and property counts.

PartialRequest
object
A partial object with attributes to update or create a partial.
7 properties 3 required
MessageTypeMarkdownField
object
A markdown field used in a message type.
4 properties 3 required
PageInfo
object
The information about a paginated result.
3 properties 1 required
MessageTypeMultiSelectField
object
A multi-select field used in a message type.
4 properties 4 required
MessageTypeBooleanField
object
A boolean field used in a message type.
4 properties 3 required
MessageTypeTextField
object
A text field used in a message type.
4 properties 3 required
Partial
object
A partial is a reusable piece of content that can be used in a template.
12 properties 7 required
MessageTypeButtonField
object
A button field used in a message type.
6 properties 5 required
MessageTypeJsonField
object
A JSON field used in a message type.
4 properties 3 required
MessageTypeTextareaField
object
A textarea field used in a message type.
4 properties 3 required
MessageTypeSelectField
object
A select field used in a message type.
4 properties 4 required
MessageTypeUrlField
object
A URL field used in a message type.
4 properties 3 required
MessageTypeImageField
object
An image field used in a message type.
7 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Knock publishes across the network.

Knock Outbound Webhooks
Knock Accounts API
Knock API keys API
Knock Audiences API
Knock Branches API
Knock Broadcasts API
Knock Bulk operations API
Knock Channel data API
Knock Channel Groups API
Knock Channels API
Knock Commits API
Knock Email layouts API