vértice
Produto Preços Painel
Canais

Atualizar foto do canal

Atualiza a foto do canal.

API key Escopo write
Exemplo de requisição
curl -X PUT "https://seu-dominio/instances/:id/newsletters/:jid/picture" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://.../canal.jpg"}'
PUT /instances/{id}/newsletters/{jid}/picture
API key
Entenda

Conceituação

Atualiza a foto do canal.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

jid string obrigatório

JID do grupo terminando em @g.us.

Body

url string opcional

URL HTTPS pública da mídia. Obrigatória no envio pela fila.

Payload

Request Body

{
  "url": "https://.../canal.jpg"
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.