Knock

Knock Objects API

The Objects API from Knock — 19 operation(s) for objects.

Documentation GitHub OpenAPI

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /v1/objects/{collection}/{id} Delete an object permanently · Delete an object #

Ask an LLM

“How do I permanently remove an object from a collection?”

“Can a deleted object be recovered?”

Tell an agent destructive · confirm first

Delete object {id} from collection {collection}.

Permanently remove {collection}/{id}.

GET /v1/objects/{collection}/{id} Get an object · Get an object #

Ask an LLM

“How do I look up an object and its properties?”

“Can I fetch one object from a collection by its ID?”

Tell an agent

Get object {id} from collection {collection}.

Show the properties of {collection}/{id}.

PUT /v1/objects/{collection}/{id} Create or update an object · Set an object #

Ask an LLM

“How do I create an object, like a project or team, to notify?”

“Can I set an object's locale and timezone when I identify it?”

Tell an agent

Set object {id} in {collection} with name {name}.

Create or update {collection}/{id} with timezone {timezone}.

PUT /v1/objects/{collection}/{object_id}/preferences/{id}/categories Update all category settings in an object's preferences · Update categories in preference set #

Ask an LLM

“How do I replace every category preference on an object at once?”

“Can I set an object's category opt-ins in one call?”

Tell an agent

Replace the categories section of preference set {id} for object {object_id} in {collection}.

Update every category opt-in at once on {collection}/{object_id}'s preference set {id}.

POST /v1/objects/{collection}/bulk/delete Delete many objects in a collection · Bulk delete objects #

Ask an LLM

“How do I delete a list of objects from one collection at once?”

“Can I bulk remove objects by their IDs?”

Tell an agent destructive · confirm first

Bulk delete objects {object_ids} from collection {collection}.

Remove these objects from {collection} in one go: {object_ids}.

PUT /v1/objects/{collection}/{object_id}/preferences/{id}/categories/{key} Update one category in an object's preferences (deprecated) · Update a category preference #

Ask an LLM

“Can I still change a single category preference on an object with the deprecated endpoint?”

“How do I opt an object out of one notification category?”

Tell an agent

Turn off category {key} in preference set {id} for object {object_id} in {collection} using the deprecated single-category endpoint.

Update the single category {key} on {collection}/{object_id}'s preference set {id}.

GET /v1/objects/{collection}/{object_id}/preferences List an object's preference sets · List preference sets #

Ask an LLM

“Which preference sets does an object have?”

“Can I see every per-tenant preference set stored on an object?”

Tell an agent

List preference sets for object {object_id} in {collection}.

Show all of {collection}/{object_id}'s preference sets.

PUT /v1/objects/{collection}/{object_id}/preferences/{id}/workflows Update all workflow settings in an object's preferences · Update workflows in preference set #

Ask an LLM

“How do I replace the workflow opt-ins for an object's preference set?”

“Can an object opt out of several workflows in one update?”

Tell an agent

Replace the workflows section of preference set {id} for object {object_id} in {collection}.

Update every workflow opt-in at once on {collection}/{object_id}'s preference set {id}.

POST /v1/objects/{collection}/bulk/subscriptions/delete Remove subscriptions from many objects · Bulk delete subscriptions #

Ask an LLM

“How do I unsubscribe recipients from many objects in one collection?”

“Are missing subscriptions skipped during a bulk delete?”

Tell an agent destructive · confirm first

Bulk delete subscriptions {subscriptions} in collection {collection}.

Unsubscribe recipients across {collection} objects using {subscriptions}.

GET /v1/objects/{collection} List objects in a collection · List objects in a collection #

Ask an LLM

“Which objects exist in a given collection?”

“Can I include preferences when listing a collection's objects?”

Tell an agent

List objects in collection {collection}.

List {collection} objects including {include}.

PUT /v1/objects/{collection}/{object_id}/preferences/{id}/channel_types/{type} Update one channel type in an object's preferences · Update a channel type preference #

Ask an LLM

“How do I turn off just email for an object's preference set?”

“Can I toggle a single channel type on an object without touching the others?”

Tell an agent

Disable channel type {type} in preference set {id} for object {object_id} in {collection}.

Update only the {type} channel type setting on {collection}/{object_id}'s preference set {id}.

PUT /v1/objects/{collection}/{object_id}/preferences/{id}/channel_types Update all channel types in an object's preferences · Update channel types in preference set #

Ask an LLM

“How do I set every channel type preference on an object at once?”

“Can I replace an object's email, SMS and push settings together?”

Tell an agent

Replace the channel types section of preference set {id} for object {object_id} in {collection}.

Update every channel type setting at once on {collection}/{object_id}'s preference set {id}.

PUT /v1/objects/{collection}/{object_id}/preferences/{id}/workflows/{key} Update one workflow in an object's preferences · Update a workflow preference #

Ask an LLM

“How do I opt an object out of a single workflow?”

“Can I change one workflow's preference on an object and leave the rest?”

Tell an agent

Turn off workflow {key} in preference set {id} for object {object_id} in {collection}.

Update just the {key} workflow preference on {collection}/{object_id}'s preference set {id}.

DELETE /v1/objects/{collection}/{object_id}/preferences/{id} Delete an object's preference set · Delete object preference set #

Ask an LLM

“How do I remove a preference set from an object entirely?”

“Can I unset an object's per-tenant preferences?”

Tell an agent destructive · confirm first

Delete preference set {id} for object {object_id} in {collection}.

Unset the {id} preferences on {collection}/{object_id}.

GET /v1/objects/{collection}/{object_id}/preferences/{id} Get one of an object's preference sets · Get object preference set #

Ask an LLM

“How do I see an object's default preference set?”

“Can I read one specific preference set on an object?”

Tell an agent

Get preference set {id} for object {object_id} in {collection}.

Show the {id} preferences of {collection}/{object_id}.

PUT /v1/objects/{collection}/{object_id}/preferences/{id} Replace or merge an object's preference set · Update a preference set #

Ask an LLM

“How do I set all of an object's preferences in one call?”

“Can I merge new preferences instead of replacing the whole set?”

Tell an agent

Update preference set {id} for object {object_id} in {collection}.

Set {collection}/{object_id}'s {id} preferences with workflows {workflows}.

POST /v1/objects/{collection}/bulk/set Create or update many objects · Bulk set objects #

Ask an LLM

“How do I upsert up to 1,000 objects into a collection at once?”

“Can I sync a whole collection of objects in one batch?”

Tell an agent

Bulk set objects {objects} in collection {collection}.

Create or update these {collection} objects in one go: {objects}.

POST /v1/schedules/bulk/create Create many schedules at once · Create schedules in bulk #

Ask an LLM

“How do I create a large number of workflow schedules in one request?”

“Is there a cap on schedules per bulk create?”

Tell an agent

Bulk create schedules {schedules}.

Create up to 1,000 schedules from {schedules} in one batch.

POST /v1/objects/{collection}/bulk/subscriptions/add Add subscriptions to many objects · Bulk add subscriptions #

Ask an LLM

“How do I subscribe recipients to lots of objects in one collection at once?”

“What happens if a subscription already exists during a bulk add?”

Tell an agent

Bulk add subscriptions {subscriptions} in collection {collection}.

Subscribe recipients across {collection} objects using {subscriptions}.

Knock Objects API

Operations 19

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification