How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Knock Audiences API

The Audiences API from Knock — 4 operation(s) for audiences.

Knock Audiences API is one of 32 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 Audiences. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 8 operations across 4 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.knock.app, https://control.knock.app.

8 operations 4 paths 39 schemas 2 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.knock.app
https://control.knock.app
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Knock Audiences 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 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Audiences 8
DELETE
/v1/audiences/{key}/members
Remove members
removeAudienceMembers 1 param body → 204
GET
/v1/audiences/{key}/members
List members
listAudienceMembers 1 param → 200
POST
/v1/audiences/{key}/members
Add members
addAudienceMembers 2 params body → 204
DELETE
/v1/audiences/{audience_key}
Archive an audience
archiveAudience 2 params → 200
GET
/v1/audiences/{audience_key}
Get an audience
getAudience 5 params → 200
PUT
/v1/audiences/{audience_key}
Upsert an audience
upsertAudience 7 params body → 200
PUT
/v1/audiences/{audience_key}/validate
Validate an audience
validateAudience 3 params body → 200
GET
/v1/audiences
List audiences
listAudiences 7 params → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are InlineIdentifyUserRequest (10 properties), DynamicAudience (9 properties), User (9 properties), StaticAudience (8 properties). Each schema is shown below with its type and property counts.

MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property 1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties 1 required
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property 1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property 1 required
DiscordChannelConnection
object
Discord channel connection.
1 property 1 required
PreferenceSetChannels
object
Channel preferences.
PushChannelDataDevicesOnly
object
Push channel data.
1 property 1 required
AudienceMember
object
An audience member.
5 properties 4 required
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
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
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS 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…
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
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
DiscordChannelData
object
Discord 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
PushChannelDataTokensOnly
object
Push channel data.
1 property 1 required
AudienceMemberRequest
object
An audience member.
2 properties 1 required
SlackChannelData
object
Slack channel data.
2 properties 1 required
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
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
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property 1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
Condition
object
A condition to be evaluated.
3 properties 3 required
RemoveAudienceMembersRequest
object
A request to remove a list of audience members.
1 property 1 required
ListAudienceMembersResponse
object
A paginated list of audience members.
2 properties 2 required
PageInfo
object
Pagination information for a list of resources.
4 properties 2 required
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property 1 required
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties
AddAudienceMembersRequest
object
A request to add a list of audience members.
1 property 1 required
Audience
object
An audience defines a set of users that can be targeted for notifications. Can be either a StaticAudience (members explicitly added/removed) or a DynamicAudien…
StaticAudienceRequest
object
Request body for creating/updating a static audience.
3 properties 2 required
PageInfo_2
object
The information about a paginated result.
3 properties 1 required
DynamicAudienceRequest
object
Request body for creating/updating a dynamic audience.
4 properties 2 required
AudienceCondition
object
A condition to evaluate for audience membership.
3 properties 2 required
AudienceRequest
object
An audience object with attributes to create or update an audience. Use type: static for audiences with explicitly managed members, or type: dynamic for audien…
DynamicAudience
object
A dynamic audience where membership is determined by segment conditions evaluated at runtime.
9 properties 7 required
StaticAudience
object
A static audience where members are explicitly added or removed via the API.
8 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-audiences-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Outbound Webhooks
Knock Accounts API
Knock API keys 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
Knock Environments API
Where this information came from

This is an independent, third-party profile of Knock Audiences API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.