This action updates key-value items used to store additional information about a channel. Values of existing items are updated and new items can be created when there no existing items with the keys.
Note: See this page to learn more about differences among data properties.
The following table lists the parameters that this action supports.
Parameters
Required | Type | Description |
---|---|---|
channel_type | string | Specifies the type of the channel. Acceptable values are |
channel_url | string | Specifies the URL of the target channel. |
Optional | Type | Description |
---|---|---|
key | string | Specifies the key of the metadata item. If not specified, the items in the |
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
metadata | nested object | Specifies a |
Optional | Type | Description |
---|---|---|
upsert | boolean | Determines whether to add new items in addition to updating existing items. If set to |
If successful, this action returns the updated or added items in the metadata in the response body.
In the case of an error, an error object like below is returned. See the error codes section for more details.