Skip to main content
POST
Promote a field

Authorizations

Authorization
string
header
required

API token issued from the Splendor console.

Headers

x-splendor-tenant-id
string
required

Selects the tenant (workspace) the request acts within.

Body

application/json
dataset_id
string
required
field_path
string
required
Minimum string length: 1
tenant_id
string
required
value_type
enum<string> | null
Available options:
text,
keyword,
i64,
f64,
datetime,
bool,
ip

Response

Successful Response

field
FieldRegistryItem · object
required
index_id
string
required
index_response
Index Response · object
required
promotion_id
string
required
reindex_required
boolean
required
status
string
required
target_generation_id
integer
required