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. This is not a transaction: the topic is read and written back, so an edit landing in between can still be lost.
In: header
Path Parameters
Domain the topic belongs to
Topic the prompt belongs to
Prompt to flag
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
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 }'