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

Knock Bulk operations API

The Bulk operations API from Knock — 12 operation(s) for bulk operations.

Knock Bulk operations API is one of 32 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 Bulk Operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 32 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.

4 operations 4 paths 32 schemas 1 GET3 POST

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
License
Proprietary
Resource Areas
1

Authentication & Security 1

Knock Bulk operations 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 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Bulk Operations 4
GET
/v1/bulk_operations/{id}
Get bulk operation
getBulkOperation 1 param → 200
POST
/v1/schedules/bulk/create
Create schedules in bulk
bulkCreateSchedules body → 200
POST
/v1/tenants/bulk/delete
Bulk delete tenants
bulkDeleteTenants 1 param → 200
POST
/v1/tenants/bulk/set
Bulk set tenants
bulkSetTenants body → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are BulkOperation (15 properties), InlineIdentifyUserRequest (10 properties), ScheduleRepeatRule (7 properties), InlineIdentifyObjectRequest (6 properties). Each schema is shown below with its type and property counts.

BulkOperation
object
A bulk operation entity.
15 properties 9 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property 1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties 1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property 1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property 1 required
DiscordChannelConnection
object
Discord channel connection.
1 property 1 required
PreferenceSetChannels
object
Channel preferences.
PushChannelDataDevicesOnly
object
Push channel data.
1 property 1 required
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
InlineIdentifyObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties 2 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property 1 required
PreferenceSetChannelSetting
object
A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
1 property 1 required
RecipientRequest
Specifies a recipient in a request. This can either be a user identifier (string), an inline user request (object), or an inline object request, which is deter…
BulkCreateSchedulesRequest
object
A request to bulk create schedules. Accepts a list of schedules to create. Each schedule must have a single recipient. The recipients do not have to be unique.
1 property 1 required
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
InlinePreferenceSetRequest
object
Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences ra…
PreferenceSetChannelTypeSetting
object
A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
1 property 1 required
DiscordChannelData
object
Discord channel data.
1 property 1 required
InlineIdentifyUserRequest
object
A set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock.…
10 properties 1 required
PushChannelDataTokensOnly
object
Push channel data.
1 property 1 required
SlackChannelData
object
Slack channel data.
2 properties 1 required
InlineTenantRequest
An request to set a tenant inline.
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property 1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
Condition
object
A condition to be evaluated.
3 properties 3 required
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
ScheduleRepeatRule
object
The repeat rule for the schedule.
7 properties 1 required
TenantRequest
object
A tenant to be set in the system. You can supply any additional properties on the tenant object.
5 properties 1 required
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property 1 required
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
BulkSetTenantsRequest
object
A request to set tenants in bulk.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-bulk-operations-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 Channel data API
Knock Channel Groups API
Knock Channels API
Knock Commits API
Knock Email layouts API
Knock Environments API
Where this information came from

This is an independent, third-party profile of Knock Bulk operations 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.