Knock

Knock Audiences API

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

Documentation GitHub OpenAPI

Operations 8

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/audiences/{key}/members Remove members from an audience · Remove members #

Ask an LLM

“How do I take specific users out of an audience?”

“Can I remove several members from one audience in one call?”

Tell an agent destructive · confirm first

Remove {members} from audience {key}.

Drop these people from the {key} audience: {members}.

GET /v1/audiences/{key}/members List the members of an audience · List members #

Ask an LLM

“Who is currently in a given audience?”

“Can I page through everyone belonging to one audience?”

Tell an agent

List the members of audience {key}.

Show who belongs to the {key} audience.

POST /v1/audiences/{key}/members Add members to an audience · Add members #

Ask an LLM

“How do I add users to an existing audience?”

“Can adding members also create the audience if it doesn't exist yet?”

Tell an agent

Add {members} to audience {key}.

Add {members} to audience {key}, creating the audience if needed ({create_audience}).

DELETE /v1/audiences/{audience_key} Archive an audience everywhere · Archive an audience #

Ask an LLM

“What happens to an audience when I archive it across all environments?”

“How do I retire an audience I no longer use?”

Tell an agent destructive · confirm first

Archive audience {audience_key} using {environment}.

Retire the {audience_key} audience across all environments, scoped from {environment}.

GET /v1/audiences/{audience_key} Get an audience definition by key · Get an audience #

Ask an LLM

“How do I look up a single audience's definition by its key?”

“Can I see an audience without its uncommitted changes?”

Tell an agent

Get audience {audience_key} in {environment}.

Show the {audience_key} audience definition on branch {branch} in {environment}.

PUT /v1/audiences/{audience_key} Create or update an audience · Upsert an audience #

Ask an LLM

“How do I create a new audience or update one that already exists?”

“Can I commit an audience change with a message when I save it?”

Tell an agent

Upsert audience {audience_key} in {environment} with {audience}.

Save audience {audience_key} and commit it with message {commit_message} in {environment}.

PUT /v1/audiences/{audience_key}/validate Validate an audience payload without saving · Validate an audience #

Ask an LLM

“Can I check an audience definition for errors before saving it?”

“Is there a dry run for audience payloads that doesn't persist anything?”

Tell an agent

Validate this audience payload for {audience_key} in {environment}: {audience}.

Dry-run audience {audience} without saving it, under key {audience_key} in {environment}.

GET /v1/audiences List audiences in an environment · List audiences #

Ask an LLM

“Which audiences exist in my development environment?”

“How many audiences can I fetch per page?”

Tell an agent

List all audiences in {environment}.

List the first {limit} audiences on branch {branch} in {environment}.

Knock Audiences API

Operations 8

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