Custom Enrichments
Create a custom enrichment
Creates a custom enrichment for your team and returns its full definition — the
same shape GET /customEnrichments lists — including the enrichment_id to use
when pushing values with PUT /mentions/customEnrichments.
constraints.enum is required:
- For
categoricalandmultivalue_categoricalenrichments it may be[](create the enrichment with no options yet) or an array of initial option strings. Options are also registered automatically whenPUT /mentions/customEnrichmentswrites a value that is not yet listed, up to 5000 per enrichment. - For
integerenrichments it must be exactly[]— integer enrichments never have options.
POST
Authorizations
Body
application/json
The data type of the enrichment's value. Cannot be changed after
creation.
categorical— one string value per mention.multivalue_categorical— several string values per mention on one field;PUT /mentions/customEnrichmentstakes an array.integer— one integer value per mention.
Available options:
categorical, multivalue_categorical, integer Example:
"categorical"
Response
The created custom enrichment, in the same shape as GET /customEnrichments.
A custom enrichment definition, as listed by GET /customEnrichments.