Knock Bulk operations API is one of 19 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 Bulk operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
12 operations
across 12 paths,
and defines 42 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against a single base URL, https://api.knock.app.
The identity and technical contract details declared by the specification.
BulkDeleteSubscriptionsRequest
object
A request to delete subscriptions for many groups of 1 subscribed-to object, N subscriber recipients.
1 property
1 required
BulkDeleteUsersRequest
object
A request to delete users in bulk.
1 property
1 required
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property
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
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
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…
InlineTenantRequest
An request to set a tenant inline.
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property
1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property
1 required
InlineIdentifyObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties
2 required
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
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
BulkIdentifyUsersRequest
object
A request to identify a list of users.
1 property
1 required
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property
1 required
DiscordChannelConnection
object
Discord channel connection.
1 property
1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push 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
Condition
object
A condition to be evaluated.
3 properties
3 required
BulkSetObjectsRequest
object
A request to set objects in bulk.
1 property
1 required
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.
BulkOperation
object
A bulk operation entity.
15 properties
9 required
BulkDeleteObjectsRequest
object
Request body for bulk deleting objects.
1 property
1 required
BulkSetUserPreferencesRequest
object
A request to set preferences for a set of users in bulk.
2 properties
2 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…
BulkSetTenantsRequest
object
A request to set tenants in bulk.
1 property
1 required
PushChannelDataTokensOnly
object
Push channel data.
1 property
1 required
DiscordChannelData
object
Discord channel data.
1 property
1 required
BulkUpsertSubscriptionsRequest
object
A request to upsert subscriptions for many groups of 1 subscribed-to object, N subscriber recipients.
1 property
1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
PreferenceSetChannels
object
Channel preferences.
BulkSetObjectRequest
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
5 properties
1 required
ScheduleRepeatRule
object
The repeat rule for the schedule.
7 properties
1 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property
1 required
SlackChannelData
object
Slack channel data.
2 properties
1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties
1 required
BulkUpdateMessagesForChannelRequest
object
Updates message statuses in a specified channel. Use the channelid parameter to target the channel and the status parameter to define what the status should be…
10 properties
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
PushChannelDataDevicesOnly
object
Push channel data.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Knock publishes across the network.
