Knock Users API
The Users API from Knock — 28 operation(s) for users.
Knock Users 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 Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.
This API exposes 35 operations across 28 paths, and defines 57 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.
35 operations
28 paths
57 schemas
4 DELETE11 GET4 POST16 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Knock Users 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 35
Across 28 paths, the API surfaces 35 operations — 4 DELETE, 11 GET, 4 POST, 16 PUT. Each is listed below with its method, path, parameters, and response codes.
Users 35
PUT
/v1/users/{user_id}/guides/messages/seen
Mark guide as seen
GET
/v1/users/{user_id}/feeds/{id}
List feed items
GET
/v1/users/{user_id}/feeds/{id}/settings
Get feed settings
GET
/v1/users/{user_id}/subscriptions
List user subscriptions
DELETE
/v1/users/{user_id}
Delete user
GET
/v1/users/{user_id}
Get user
PUT
/v1/users/{user_id}
Identify user
PUT
/v1/users/{user_id}/preferences/{id}/categories/{key}deprecated
Update category in user preference set
PUT
/v1/users/{user_id}/guides/messages/{message_id}/seen
Mark guide as seen
DELETE
/v1/users/{user_id}/guides/messages/archived
Mark guide as unarchived
PUT
/v1/users/{user_id}/guides/messages/archived
Mark guide as archived
DELETE
/v1/users/{user_id}/channel_data/{channel_id}
Unset channel data
GET
/v1/users/{user_id}/channel_data/{channel_id}
Get channel data
PUT
/v1/users/{user_id}/channel_data/{channel_id}
Set channel data
POST
/v1/users/{user_id}/merge
Merge users
PUT
/v1/users/{user_id}/guides/messages/interacted
Mark guide as interacted
PUT
/v1/users/{user_id}/guides/engagements/reset
Reset guide engagement
POST
/v1/users/bulk/preferences
Bulk set preferences
GET
/v1/users/{user_id}/guides/{channel_id}
List guides
POST
/v1/users/bulk/identify
Bulk identify users
PUT
/v1/users/{user_id}/preferences/{id}/workflowsdeprecated
Update workflows in preference set
PUT
/v1/users/{user_id}/preferences/{id}/categoriesdeprecated
Update categories in user preference set
PUT
/v1/users/{user_id}/guides/messages/{message_id}/interacted
Mark guide as interacted
POST
/v1/users/bulk/delete
Bulk delete users
PUT
/v1/users/{user_id}/preferences/{id}/channel_types/{type}deprecated
Update channel type in preference set
GET
/v1/users/{user_id}/preferences
List user preference sets
GET
/v1/users/{user_id}/schedules
List user schedules
PUT
/v1/users/{user_id}/guides/messages/{message_id}/archived
Mark guide as archived
GET
/v1/users/{user_id}/messages
List user messages
GET
/v1/users
List users
PUT
/v1/users/{user_id}/preferences/{id}/workflows/{key}deprecated
Update workflow in user preference set
DELETE
/v1/users/{user_id}/preferences/{id}
Delete user preference set
GET
/v1/users/{user_id}/preferences/{id}
Get user preference set
PUT
/v1/users/{user_id}/preferences/{id}
Update user preference set
PUT
/v1/users/{user_id}/preferences/{id}/channel_typesdeprecated
Update channel types in preference set
Schemas 57
The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are Message (22 properties), InAppFeedItem (18 properties), BulkOperation (15 properties), Schedule (12 properties). Each schema is shown below with its type and property counts.
Message
object
Represents a single message that was generated by a workflow for a given channel.
22 properties
9 required
SlackTokenConnection
object
A Slack connection token.
3 properties
UserInAppFeedSettingsResponse
object
The response for the user's feed settings.
1 property
1 required
PushChannelDataTokensOnly
object
Push channel data.
1 property
1 required
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…
User
object
A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifica…
9 properties
3 required
ListUsersResponse
object
A paginated list of users.
2 properties
BulkDeleteUsersRequest
object
A request to delete users in bulk.
1 property
1 required
PushChannelDataFull
object
Push channel data.
2 properties
2 required
Activity
object
An activity associated with a workflow trigger request. Messages produced after a [batch step](/designing-workflows/batch-function) can be associated with one…
7 properties
ListSubscriptionsResponse
object
A response containing a list of subscriptions.
2 properties
2 required
GuideActionRequest
object
A request to trigger a guide action.
9 properties
4 required
GuidesResponse
object
A response for a list of guides.
4 properties
4 required
ChannelDataRequest
object
A request to set channel data for a type of channel.
1 property
1 required
PreferenceSetChannels
object
Channel preferences.
ListMessagesResponse
object
A paginated list of messages.
2 properties
2 required
IdentifyUserRequest
object
A set of parameters to identify a user with. Does not include the user ID, as that's specified elsewhere in the request. You can supply any additional properti…
9 properties
AWSSNSPushChannelDataFull
object
AWS SNS push channel data.
2 properties
2 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property
1 required
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
MergeUserRequest
object
A set of parameters to merge one user into another.
1 property
1 required
ListSchedulesResponse
object
A response containing a list of schedules.
2 properties
2 required
PushChannelDataDevicesOnly
object
Push channel data.
1 property
1 required
Schedule
object
A schedule represents a recurring workflow execution.
12 properties
6 required
DiscordChannelData
object
Discord channel data.
1 property
1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties
1 required
SlackChannelData
object
Slack channel data.
2 properties
1 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
Condition
object
A condition to be evaluated.
3 properties
3 required
Object
object
A custom [Object](/concepts/objects) entity which belongs to a collection.
6 properties
4 required
PageInfo
object
Pagination information for a list of resources.
4 properties
2 required
BulkIdentifyUsersRequest
object
A request to identify a list of users.
1 property
1 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property
1 required
PreferenceSetChannelTypes
object
Channel type preferences.
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
MessageInAppFeedButtonSetBlock
object
A button set block in a message in an app feed.
3 properties
3 required
BulkSetUserPreferencesRequest
object
A request to set preferences for a set of users in bulk.
2 properties
2 required
Recipient
object
A recipient of a notification, which is either a user or an object.
InAppFeedItem
object
An in-app feed message in a user's feed.
18 properties
12 required
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
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
GuideActionResponse
object
A response for a guide action.
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
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property
1 required
UserInAppFeedResponse
object
A paginated list of feed items.
4 properties
4 required
ScheduleRepeatRule
object
The repeat rule for the schedule.
7 properties
1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property
1 required
Subscription
object
A subscription object.
6 properties
5 required
ChannelData
object
Channel data for a given channel type.
4 properties
3 required
DiscordChannelConnection
object
Discord channel connection.
1 property
1 required
MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property
1 required
MessageInAppFeedContentBlock
object
A block in a message in an app feed.
4 properties
4 required
BulkOperation
object
A bulk operation entity.
15 properties
9 required
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
RecipientReference
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Knock 12
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
#Users