Skip to main content
Create Custom Enrichments

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

This request data structure is used to create a custom enrichment

description
string
required

Human-readable description of the custom enrichment.

Maximum string length: 255
Pattern: ^[\s\S]*$
Example:

"custom_enrichment_description"

file
File · object
required

This data structure represents a file

name
string
required

Human-readable name for the custom enrichment. May contain only letters, digits, and underscores.

Required string length: 1 - 255
Pattern: ^\w+$
Example:

"custom_enrichment_name"

Response

200 - application/json

This response data structure is obtained when a custom enrichment is created

customEnrichment
object

Custom enrichment.

message
string

Human-readable message.

Maximum string length: 4096
Pattern: ^[\s\S]*$
Example:

"Custom enrichment created successfully"