# Knock Users API

**Canonical:** https://apis.io/apis/knock-app/knock-app-users-api/  
**Provider:** Knock — https://apis.io/providers/knock-app/  
**Base URL:** https://api.knock.app  
**Documentation:** https://docs.knock.app/api-reference/workflows

Knock Users API is one of 35 APIs that [Knock](https://apis.io/providers/knock-app/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

The Users API from Knock — 28 operation(s) for users.

## Operations (35)

| Method | Path | Summary |
|---|---|---|
| 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}` | 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}/workflows` | Update workflows in preference set |
| PUT | `/v1/users/{user_id}/preferences/{id}/categories` | 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}` | 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}` | 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_types` | Update channel types in preference set |

## Machine-readable artifacts (22)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/openapi/knock-app-users-api-openapi.yml
- **Documentation** — https://docs.knock.app/api-reference/workflows
- **Documentation** — https://docs.knock.app/send-notifications/triggering-workflows/api
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/json-schema/knock-workflow-trigger-schema.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-trigger-workflow-example.json
- **GraphQL** — https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/graphql/knock-app-graphql.md
- **Documentation** — https://docs.knock.app/api-reference/users
- **Examples** — https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-identify-user-example.json
- **Documentation** — https://docs.knock.app/api-reference/messages
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/json-schema/knock-message-schema.json
- **Documentation** — https://docs.knock.app/api-reference/objects
- **Documentation** — https://docs.knock.app/api-reference/tenants
- **Documentation** — https://docs.knock.app/api-reference/schedules
- **Documentation** — https://docs.knock.app/concepts/schedules
- **Examples** — https://raw.githubusercontent.com/api-evangelist/knock-app/refs/heads/main/examples/knock-create-schedule-example.json
- **Documentation** — https://docs.knock.app/api-reference/audiences
- **Documentation** — https://docs.knock.app/api-reference/channels
- **Documentation** — https://docs.knock.app/api-reference/providers
- **Documentation** — https://docs.knock.app/api-reference/integrations
- **Documentation** — https://docs.knock.app/api-reference/bulk_operations
- **Documentation** — https://docs.knock.app/mapi
- **Documentation** — https://docs.knock.app/developer-tools/management-api

## Other Knock APIs (12)

- [Knock Outbound Webhooks](https://apis.io/apis/knock-app/knock-webhooks/)
- [Knock Accounts API](https://apis.io/apis/knock-app/knock-app-accounts-api/)
- [Knock API keys API](https://apis.io/apis/knock-app/knock-app-api-keys-api/)
- [Knock Audiences API](https://apis.io/apis/knock-app/knock-app-audiences-api/)
- [Knock Branches API](https://apis.io/apis/knock-app/knock-app-branches-api/)
- [Knock Broadcasts API](https://apis.io/apis/knock-app/knock-app-broadcasts-api/)
- [Knock Bulk operations API](https://apis.io/apis/knock-app/knock-app-bulk-operations-api/)
- [Knock Channel data API](https://apis.io/apis/knock-app/knock-app-channel-data-api/)
- [Knock Channel Groups API](https://apis.io/apis/knock-app/knock-app-channel-groups-api/)
- [Knock Channels API](https://apis.io/apis/knock-app/knock-app-channels-api/)
- [Knock Commits API](https://apis.io/apis/knock-app/knock-app-commits-api/)
- [Knock Email layouts API](https://apis.io/apis/knock-app/knock-app-email-layouts-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/knock-app/knock-app-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/knock-app/.
