Create or update a component within a component group

put

https://developers.bloomreach.io/management/site/v1/channels/{channel_id}/component_groups/{group_name}/components/{component_name}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

channel_id

string

required

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

group_name

string

required

Name of group

component_name

string

required

Name of component

Body Params

string

required

identifier of this component definition: {group}/{name}

extends

string

required

{group}/{name} id of the component definition this definition extends from

hidden

boolean

indicator if this component definition is configurable in the ChannelManager UI

system

boolean

indicator if this a protected (system) component definition; if true, implies hidden is true

xtype

string

frontend layout type

ctype

string

frontend component type

contentType

string

contentType for cases where the component should also create content: when putting, the contentType must be an existing document compound type, otherwise the request is not executed. The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:titleandtext

label

string

default display name of this component definition in the ChannelManager UI

icon

string

base64 representation of the icon for this component definition in the ChannelManager UI

parameters

array of objects

custom (residual) or customized (overlaying) parameters for this component definition. Parameters with config type 'imagesetpath' are not allowed

parameters

fieldGroups

array of objects

field groups

fieldGroups

Headers

X-Resource-Version

string

Resource's version. Must be used in any subsequent update requests of this resource. Can be obtained when GETting the resource

Responses

403

Forbidden

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

201Created