API Reference
Include or exclude one prompt from the Ads surfaces
Flags a single prompt. Excluded prompts are filtered out of every Ads response, so the Ads pages stop counting them entirely rather than showing them at zero. A prompt with no flag is included, which is what keeps prompts created before the flag existed on the Ads pages. Takes only the one prompt id, so a caller never has to send a prompt list it may have loaded before someone else edited it. The topic is read and written back; if another change lands in between, the toggle is refused with 409 rather than overwriting it.
AuthorizationBearer <token>
In: header
Path Parameters
domainId*string
Domain the topic belongs to
topicId*string
Topic the prompt belongs to
promptId*string
Prompt to flag
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/api/domains/3fa85f64-5717-4562-b3fc-2c963f66afa6/topics/3fa85f64-5717-4562-b3fc-2c963f66afa6/prompts/3fa85f64-5717-4562-b3fc-2c963f66afa6/ads-inclusion" \ -H "Content-Type: application/json" \ -d '{ "included": false }'{ "id": "123e4567-e89b-12d3-a456-426614174000", "domainId": "123e4567-e89b-12d3-a456-426614174000", "name": "AI and Machine Learning", "displayName": "Running shoes", "competitionSubject": "trail running shoes", "description": "Discussions about artificial intelligence and ML technologies", "icon": "Brain", "keywords": [ "artificial intelligence", "machine learning", "AI" ], "language": "en", "market": "US", "persona": "Marketing manager evaluating running shoe brands", "visibilityPrompts": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "text": "What are the best running shoe brands?", "createdAt": "2026-05-25T10:30:00.000Z", "updatedAt": "2026-05-25T10:30:00.000Z" } ], "competitionPrompts": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "text": "How does nike.com compare to its competitors?", "createdAt": "2026-05-25T10:30:00.000Z", "updatedAt": "2026-05-25T10:30:00.000Z" } ], "evaluationCriteria": [ "price", "product-quality", "customer-service" ], "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2026-05-25T10:30:00.000Z", "updatedAt": "2026-05-25T10:30:00.000Z", "lastAnalysisAt": "2026-05-25T10:30:00.000Z", "nextAnalysisAt": "2026-05-26T10:30:00.000Z", "enabledFeatures": { "visibility": true, "competition": true, "ads": true, "shopping": true }, "sortOrder": 0, "competitors": [ { "id": "6736c1a8a0b2f1e2d3c4b5a6", "name": "OpenAI", "urls": [ "https://openai.com", "https://chat.openai.com" ], "aliases": [ "OAI" ] } ]}