VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Lives (Live Commerce)

Alterar e apagar sessão

Altera campos de uma sessão de live ou a apaga, com os destaques e o chat.

O PUT é parcial: envie só os campos que mudam. Uso comum: corrigir o horário antes da live ou colocar a replay_url depois que ela acaba. O estado não muda por aqui.

Alterar sessão

PUT/api/v1/vendor/live-sessions/{id}Seller

Altera uma sessão

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório
Id da sessão.

Corpo da requisição

titlestring
Novo título.
descriptionstring
Nova descrição.
scheduled_atstring
Novo horário (RFC 3339). Aqui não há checagem de passado.
embed_urlstring
Nova URL do player.
replay_urlstring
URL da gravação.
statusstring
Não use. Qualquer valor responde 409; o estado muda por start, end e cancel.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1/vendor/live-sessions/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "replay_url": "https://www.youtube.com/embed/GRAVACAO"
}'
200Sessão atualizada
json
{
  "id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "vendor_name": "Loja Seller Teste",
  "title": "Lançamento da coleção de verão",
  "description": "Mostramos as novidades e respondemos perguntas ao vivo.",
  "scheduled_at": "2026-10-20T19:00:00Z",
  "embed_url": "https://www.youtube.com/embed/EXEMPLO",
  "replay_url": "https://www.youtube.com/embed/GRAVACAO",
  "status": "scheduled",
  "viewer_count_peak": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "updated_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

...object
A sessão completa, como em Criar sessão.

Apagar sessão

DELETE/api/v1/vendor/live-sessions/{id}Seller

Apaga uma sessão

Remove a sessão de vez, junto com os produtos em destaque e as mensagens do chat. Não há como desfazer e não há confirmação de estado: uma sessão live também é apagada.

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório
Id da sessão.

Exemplo de requisição

bash
curl -X DELETE "$BASE_URL/api/v1/vendor/live-sessions/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60" \
  -H "Authorization: Bearer $TOKEN"
200Sessão apagada
json
{
  "message": "deleted"
}

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário do seller (equipe) não tem nenhum dos privilégios exigidos. O dono da loja nunca recebe este erro.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}
403O módulo Live Commerce está desligado nesta loja.{"error":"module_disabled","module":"live-commerce"}
404O id não é um UUID ou a sessão não existe.{"error":"LIVE_SESSION_NOT_FOUND"}
403A sessão pertence a outro seller.{"error":"SESSION_OWNERSHIP_REQUIRED"}
400JSON inválido.{"error":"INVALID_BODY","detail":"..."}
409status enviado no PUT.{"error":"LIVE_SESSION_STATUS_NOT_UPDATABLE","detail":"status cannot be changed via update; use start/end"}
400Falha ao apagar (por exemplo, a sessão sumiu entre a checagem e a exclusão).{"error":"LIVE_SESSION_DELETE_FAILED","detail":"live session ... not found"}
Apagar é definitivo

Se você só quer tirar a live do ar, use cancelar ou encerrar: o histórico e o chat ficam guardados.

Veja também

  • Ciclo de vida
  • Listar e consultar
Anterior
Listar e consultar lives
Próxima
Ciclo de vida da live
Nesta página
  • Alterar sessão
  • Exemplo de requisição
  • Apagar sessão
  • Exemplo de requisição
  • Erros
  • Veja também