Definitions
Update a definition
PATCH/definitions/{definitionId}
ScopeadminRoleOwner or adminBilling1 credit per call
Changes a definition's name, description, instruction, thresholds or policy, and adds or archives enum values. Archived definitions reject changes.
Path parameters
definitionIduuidrequired
Definition id.
Headers
Idempotency-Keystringoptional
1–128 visible ASCII characters. Retrying with the same key returns the original response; reusing it for different input returns 409.
Body
namestringoptional
1–80 characters.
descriptionstringoptional
Up to 1000 characters.
instructionstringoptional
Up to 2000 characters.
addEnumValuesEnumValue[]optional
Up to 200 new values.
archiveEnumValueSlugsstring[]optional
Slugs to archive.
refreshPolicyenumoptional
on_ingest · on_ingest_and_backfill · manual
autoApplyThresholdnumberoptional
0–1
reviewThresholdnumberoptional
0–1
chatVisiblebooleanoptional
reasonstringrequired
Why this change is being made. 1–500 characters. Stored in the audit trail.
Response
…Definition