Bulk Clusters by Id

POST 
/clusters/bulk/id

The bulk endpoints offer an efficient way of importing/updating large amounts of clusters with just a single API call. When using the bulk id endpoint, the clusters are identified by Propeller cluster id. If a cluster with such id doesn't already exist, it will be created. If it does exist, the cluster will be updated.

Fields

Name	Required
clusters (array of cluster objects)	yes
sourceId	yes
source	yes
language	yes
names	yes
descriptions	no
shortDescriptions	no
parent	yes
metadataTitles	no
metadataDescriptions	no
metadataKeywords	no
metadataCanonicalUrls	no
priority	no

Directives

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing category that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing category in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a category that are not provided in the payload	empty array

What are directives?

Request

application/json

Body

clusters

object[]

Array [

clusterConfigId number

code string

descriptions

object[]

Array [

language string

value string

]

id number

names

object[]

Array [

language string

value string

]

parent

object

id number

]

directives

object[]

Array [

fields string[]

operation string

]

Responses

200

Loading...