Knock Preferences API

Preferences are a way to configure how notifications are sent to recipients. They are a set of configuration that determines whether a recipient should receive a notification for a given workflow on a specific channel.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 20 operations across 16 paths, and defines 8 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.

20 operations 16 paths 8 schemas 2 DELETE4 GET14 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

1.0

Base URL

https://api.knock.app/v1

Authentication

HTTP Bearer

Resource Areas

Authentication & Security 1

Knock Preferences API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 20

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

Preferences 20

Preferences are a way to configure how notifications are sent to recipients. They are a set of configuration that determines whether a recipient should receive a notification for…

PUT

/v1/objects/{collection}/{object_id}/preferences/{id}/workflowsdeprecated

Update workflows in preference set

updateObjectPreferenceWorkflows → 200

PUT

/v1/objects/{collection}/{object_id}/preferences/{id}/channel_types/{type}deprecated

Update a channel type preference

updateObjectPreferenceChannelType → 200

PUT

/v1/users/{user_id}/preferences/{id}/categories/{key}deprecated

Update category in user preference set

updateUserPreferenceCategory → 200

PUT

/v1/objects/{collection}/{object_id}/preferences/{id}/categories/{key}deprecated

Update a category preference

updateObjectPreferenceCategory → 200

GET

/v1/objects/{collection}/{object_id}/preferences

List preference sets

listObjectPreferenceSets 2 params → 200

PUT

/v1/objects/{collection}/{object_id}/preferences/{id}/workflows/{key}deprecated

Update a workflow preference

updateObjectPreferenceWorkflow → 200

PUT

/v1/users/{user_id}/preferences/{id}/workflowsdeprecated

Update workflows in preference set

updateUserPreferenceWorkflows → 200

PUT

/v1/objects/{collection}/{object_id}/preferences/{id}/categoriesdeprecated

Update categories in preference set

updateObjectPreferenceCategories → 200

PUT

/v1/users/{user_id}/preferences/{id}/categoriesdeprecated

Update categories in user preference set

updateUserPreferenceCategories → 200

PUT

/v1/users/{user_id}/preferences/{id}/channel_types/{type}deprecated

Update channel type in preference set

updateUserPreferenceChannelType → 200

GET

/v1/users/{user_id}/preferences

List user preference sets

listUserPreferenceSets 1 param → 200

PUT

/v1/objects/{collection}/{object_id}/preferences/{id}/channel_typesdeprecated

Update channel types in preference set

updateObjectPreferenceChannelTypes → 200

PUT

/v1/users/{user_id}/preferences/{id}/workflows/{key}deprecated

Update workflow in user preference set

updateUserPreferenceWorkflow → 200

DELETE

/v1/objects/{collection}/{object_id}/preferences/{id}

Delete object preference set

deleteObjectPreferenceSet 3 params → 204

GET

/v1/objects/{collection}/{object_id}/preferences/{id}

Get object preference set

getObjectPreferenceSet 3 params → 200

PUT

/v1/objects/{collection}/{object_id}/preferences/{id}

Update a preference set

updateObjectPreferenceSet 3 params body → 200

DELETE

/v1/users/{user_id}/preferences/{id}

Delete user preference set

deleteUserPreferenceSet 2 params → 204

GET

/v1/users/{user_id}/preferences/{id}

Get user preference set

getUserPreferenceSet 3 params → 200

PUT

/v1/users/{user_id}/preferences/{id}

Update user preference set

updateUserPreferenceSet 2 params body → 200

PUT

/v1/users/{user_id}/preferences/{id}/channel_typesdeprecated

Update channel types in preference set

updateUserPreferenceChannelTypes → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PreferenceSetRequest (6 properties), PreferenceSet (6 properties), PreferenceSetChannelTypes (6 properties), Condition (3 properties). Each schema is shown below with its type and property counts.

PreferenceSetWorkflowCategorySetting

object

Workflow or category preferences within a preference set

PreferenceSetChannels

object

Channel preferences.

PreferenceSetChannelTypes

object

Channel type preferences.

6 properties

Condition

object

A condition to be evaluated.

3 properties 3 required

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

PreferenceSet

object

A preference set represents a specific set of notification preferences for a recipient. A recipient can have multiple preference sets.

6 properties 1 required

PreferenceSetRequest

object

A request to set a preference set for a recipient.

6 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Knock publishes across the network.

Knock Audiences API

AE Profile APIs.io

Knock Bulk operations API

AE Profile APIs.io

Knock Channel data API

AE Profile APIs.io

Knock Feeds API

AE Profile APIs.io

Knock Guides API

AE Profile APIs.io

Knock Integrations API

AE Profile APIs.io

Knock Messages API

AE Profile APIs.io

Knock Microsoft Teams API

AE Profile APIs.io

Knock Objects API

AE Profile APIs.io

Knock Providers API

AE Profile APIs.io

Knock Schedules API

AE Profile APIs.io

Knock Slack API

AE Profile APIs.io

#Preferences

← Back to K APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Knock Preferences API

Metadata

Authentication & Security 1

Paths & Operations 20

Schemas 8

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Knock Preferences API

Metadata

Authentication & Security 1

Paths & Operations 20

Schemas 8

Specification

Source

More from Knock 12

API Details

Provider

Explore more