Update prompt
Update only supplied fields. Omitted values are preserved.
/projects/{projectId}/prompts/{id}prompts:writeThe key must include this project and its owner must still have access.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Path parameters
projectIdstringRequiredProject identifier from List projects.
idstringRequiredIdentifier from the corresponding resource list.
Request body
application/json. Unknown fields are rejected. Changes apply only to supplied fields; provide at least one field.
textstringOptionalQuestion text, 1–10,000 characters.
categoryIdstring | nullOptionalCategory in this project. Creation without a category uses General.
followUpsstring[]OptionalUp to four questions, each 1–10,000 characters.
intentstringOptionallearn, compare, buy or find_brand.
brandedbooleanOptionalWhether this question names a brand.
activebooleanOptionalWhether the prompt is active. Existing enabled tracking can include active prompts.
archivedbooleanOptionalArchive or restore this prompt.
targetUrlstring | nullOptionalPublic page on this project’s website, up to 2,000 characters. Null clears the target.
Response fields
dataobjectRequiredUpdate only supplied fields. Omitted values are preserved.
Child fields
idstringRequiredUnique identifier for this record.
projectIdstringRequiredProject that owns this record.
categoryIdstring | nullRequiredSaved category id.
textstringRequiredSaved text.
marketstringRequiredSaved market.
languagestringRequiredSaved language.
brandedbooleanRequiredSaved branded.
intentstringRequiredSaved intent.
followUpsJSONRequiredFollow-up questions in their saved order.
activebooleanRequiredSaved active.
archivedbooleanRequiredSaved archived.
targetUrlstring | nullRequiredSaved target url.
createdAtISO 8601 timestampRequiredWhen this record was saved, in UTC.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.