Atualizar canal

PUT https://.account-name.krzlabs.io/api/v1/channels/:id

Realiza a atualização de um canal.


Path Params

id string required
ID do canal.

Body Params

Field Type Description optional Searchable
channels array(id) Código do canal. not required false
category_tree ObjectId Código da árvore de categorias. not required false
stocks array(id) Código do estoque. not required false
prices array(id) Código do preço. not required false
type ObjectId Tipo do canal. required false
code string Código do único do canal. required true
name string Nome do canal. required true
description string Descrição do canal. not required false
enabled boolean Ativo do canal. required false
tags array(string) Tags do canal. not required false
app_id ObjectId App do canal. not required false
Exemplo em JSON
{
  "channels": [
    "64f1b3d4e5d987654321cdef",
    "64f1c4e6e5d567890abcd123"
  ],
  "category_tree": "64f1d5f8e5d135790abcdef1",
  "stocks": [
    "64f1e6a7e5d987654321caaa",
    "64f1f7b8e5d567890abcd456"
  ],
  "prices": [
    "64f1g8c9e5d135790abcdef2",
    "64f1h9dae5d135790abcdef3"
  ],
  "type": "64f1i0ebe5d135790abcdef4",
  "code": "CHANNEL001",
  "name": "Canal de Vendas",
  "description": "Descrição do canal de vendas.",
  "enabled": true,
  "tags": [
    "marketplace",
    "promoção",
    "oficial"
  ],
  "app_id": "64f1j1fce5d135790abcdef5"
}

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description optional Searchable
channels array(id) Código do canal. not required false
category_tree ObjectId Código da árvore de categorias. not required false
stocks array(id) Código do estoque. not required false
prices array(id) Código do preço. not required false
type ObjectId Tipo do canal. required false
code string Código do único do canal. required true
name string Nome do canal. required true
description string Descrição do canal. not required false
enabled boolean Ativo do canal. required false
tags array(string) Tags do canal. not required false
app_id ObjectId App do canal. not required false

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved