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 Translations API

Translations are per-locale string files that can be used in your templates.

Knock Translations 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 Translations. 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 3 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 3 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 Translations 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.

Translations 4

Translations are per-locale string files that can be used in your templates.

GET
/v1/translations
List translations
listTranslations 11 params → 200
PUT
/v1/translations/{locale_code}/validate
Validate translation
validateTranslation 3 params body → 200
GET
/v1/translations/{locale_code}
Get translation
getTranslation 8 params → 200
PUT
/v1/translations/{locale_code}
Upsert translation
upsertTranslation 10 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Translation (7 properties), PageInfo (3 properties), TranslationRequest (2 properties). Each schema is shown below with its type and property counts.

PageInfo
object
The information about a paginated result.
3 properties 1 required
Translation
object
A translation object.
7 properties 6 required
TranslationRequest
object
A translation object with a content attribute used to update or create a translation.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-translations-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