API Reference
Set which modules one prompt feeds
Writes the prompt's module list, which is what decides the scope it is measured in: Visibility, Ads, Shopping. The list can never be empty, so the last module cannot be removed; a prompt in no module would be run by nothing and score nowhere.
AuthorizationBearer <token>
Session JWT signed with HS256. Verification pins the algorithm and rejects expired tokens, per RFC8725.
In: header
Path Parameters
domainId*string
Domain the prompts belong to
promptId*string
Prompt to act on; it is looked up across the domain topics
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/topic-prompts/3fa85f64-5717-4562-b3fc-2c963f66afa6/modules" \ -H "Content-Type: application/json" \ -d '{ "modules": [ "visibility", "ads" ] }'{ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "text": "best refurbished iPhone", "adsIncluded": true, "criterion": "pricing", "topicId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "topicName": "Refurbished smartphones", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}