curl --request PUT \
  --url https://api.peakmetrics.com/customEnrichments/{enrichmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed",
      "Debunked"
    ]
  }
}
'

{
  "enrichment_id": 1681,
  "name": "Disinformation Analysis",
  "type": "categorical",
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed",
      "Debunked"
    ]
  }
}

{
  "error": "'constraints.enum' contains a duplicate value: 'Mixed'"
}

{
  "error": "Custom enrichment not found"
}

{
  "error": "'constraints.enum' contains a duplicate value: 'Mixed'"
}

Custom Enrichments

Edit a custom enrichment

Renames a custom enrichment and/or replaces its option list, and returns the updated definition in the same shape as GET /customEnrichments.

Full replace, not a diff

constraints.enum is required and fully replaces the currently listed options: whatever array you submit becomes the complete set of listed options going forward. Send the full intended list every time — ["A", "B"] followed by ["B", "C"] leaves only B and C listed. [] removes every option.

This works the same way for categorical and multivalue_categorical enrichments — both carry an option list. For integer enrichments constraints.enum must be exactly []; editing an integer enrichment is limited to its name.

Restoring options

Omitting a previously listed option delists it without deleting the values already written to mentions. Re-adding a previously removed option restores it, together with the mentions tagged under it — as long as it is spelled exactly as before, including capitalization and spacing. An option that differs by case or spacing is treated as a new, separate option ("Gold" and "gold" are two distinct options).

Self-registration still applies

This endpoint controls the explicitly managed list at the moment it is called. Values pushed with PUT /mentions/customEnrichments that are not yet listed are still registered automatically, exactly as before, and GET /customEnrichments continues to reflect the current full set of listed options however they arrived.

type cannot be changed.

PUT

customEnrichments

{enrichmentId}

curl --request PUT \
  --url https://api.peakmetrics.com/customEnrichments/{enrichmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed",
      "Debunked"
    ]
  }
}
'

{
  "enrichment_id": 1681,
  "name": "Disinformation Analysis",
  "type": "categorical",
  "constraints": {
    "enum": [
      "Uncorroborated",
      "Substantiated",
      "Mixed",
      "Debunked"
    ]
  }
}

{
  "error": "'constraints.enum' contains a duplicate value: 'Mixed'"
}

{
  "error": "Custom enrichment not found"
}

{
  "error": "'constraints.enum' contains a duplicate value: 'Mixed'"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

enrichmentId

integer

required

The enrichment_id from GET /customEnrichments.

Body

application/json

constraints

object

required

Show child attributes

name

string

A new display name. Optional; when present it must be unique among your team's custom enrichments (compared case-insensitively).

Maximum string length: 255

Example:

"Disinformation Analysis"

Response

The updated custom enrichment, reflecting the replaced option list.

A custom enrichment definition, as listed by GET /customEnrichments.

enrichment_id

integer

The unique identifier. Use it as enrichment_id when pushing values with PUT /mentions/customEnrichments.

Example:

1681

name

string

The display name.

Example:

"Disinformation Analysis"

type

enum<string>

The data type of the enrichment's value. Fixed at creation.

Available options:

categorical,

multivalue_categorical,

integer

Example:

"categorical"

constraints

object

Show child attributes

⌘I