Open Web UIInstall

Summary

Update a specific channel identified by its ID by sending an HTTP POST request with JSON payload containing channel details.

Inputs

• Id (required) — The unique identifier of the channel to update, provided in the path parameter.
• Name (required) — The new name for the channel, provided in the request body.
• Description — Optional description of the channel, provided in the request body.
• Data — Optional JSON object containing additional data for the channel.
• Meta — Optional JSON object containing metadata for the channel.
• Access Control — Optional JSON object defining access control settings for the channel.
• Skip Authentication — Whether to skip authentication for this request; defaults to false.

Output shape

a JSON object representing the updated channel resource

Returns the updated channel object in JSON format. The operation uses an HTTP POST to the path '/api/v1/channels/{id}/update' with the channel ID specified in the path parameter 'id'. The request body must include at least the 'name' field; other fields are optional. Authentication is required by default unless 'Skip Authentication' is enabled.

Examples

Example 1: Updating Channel with ID and new data

Set 'Id' to the target channel's ID. Provide at least the 'Name' in the request body. Optionally provide 'Description', 'Data', 'Meta', and 'Access Control'. Execute to apply updates.

Links

• n8n community nodes installation guide