v1

latestOpenAPI 3.1.02026-07-2683111282.3 KB
Channel Operations

Add or update meta-data for a channel parameter

Add or update the meta-data for a specific channel parameter. Note: updating or setting a parameter <b>value</b> is done via PUT /channels/{channel_id}

put/channels/{channel_id}/parameters/{parameter_name}

Path parameters

channel_idstring required

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

parameter_namestring required

Name of the parameter

Headers

X-Resource-Versionstring

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

Request body

namestring required
valueType'string' | 'calendar' | 'boolean' | 'integer' | 'number' required
requiredboolean
hiddenboolean
overlayboolean
defaultValueobject
displayNamestring
systemboolean

System readonly parameter

Response

OK

namestring required
valueType'string' | 'calendar' | 'boolean' | 'integer' | 'number' required
requiredboolean
hiddenboolean
overlayboolean
defaultValueobject
displayNamestring
systemboolean

System readonly parameter