API atual/Referência completa/Sessões ao vivo

Alterar e apagar sessão

Altera título, horário e endereços de uma sessão ou a apaga.

Atualizar sessão ao vivo

Atualiza só os campos enviados. O estado não muda por aqui: para isso use start, end e cancel. Enviar status é recusado.

PUT/api/v1/admin/live-sessions/{id}Admin

Altera título, horário e endereços de uma sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

titlestring

Novo título.

descriptionstring

Nova descrição.

scheduled_atstring

Novo início previsto (RFC 3339).

embed_urlstring

Novo endereço da transmissão.

replay_urlstring

Endereço da gravação. Preencha depois que a sessão terminar para liberar a reprise e os clipes.

Exemplo de requisição (Atualizar sessão)

bash

curl -X PUT "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "replay_url": "https://www.youtube.com/watch?v=replay456"
}'

Resposta (Atualizar sessão)

200Sessão atualizada

json

{
  "id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "vendor_name": "Loja Seller Teste",
  "title": "Lançamento da coleção de verão",
  "description": "Ao vivo com ofertas exclusivas",
  "scheduled_at": "2026-12-05T18:00:00Z",
  "embed_url": "https://www.youtube.com/watch?v=abc123",
  "replay_url": "https://www.youtube.com/watch?v=replay456",
  "status": "scheduled",
  "viewer_count_peak": 0,
  "created_at": "2026-10-11T21:05:21.230055Z",
  "updated_at": "2026-10-11T21:05:21.230055Z"
}

Campos da resposta

iduuid

Identificador da sessão.

vendor_iduuid

Seller que apresenta a sessão.

vendor_namestring

Nome do seller, para exibir.

titlestring

Título.

descriptionstring

Descrição.

scheduled_atstring

Data e hora prevista de início, RFC 3339.

started_atstring

Quando foi ao ar. Ausente antes de começar.

ended_atstring

Quando terminou ou foi cancelada. Ausente enquanto não terminou.

embed_urlstring

Endereço da transmissão (YouTube, Vimeo, Mux...) que a vitrine coloca num player.

replay_urlstring

Endereço da gravação, usado depois que a sessão termina. Vazio se não houver.

statusstring

scheduled, live, ended ou cancelled.

viewer_count_peakinteger

Maior número de espectadores simultâneos.

created_atstring

Criação, RFC 3339.

updated_atstring

Última alteração, RFC 3339.

Erros (Atualizar sessão)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
404	Não existe sessão com esse `id`, ou o `id` não é um UUID.	`{"error":"LIVE_SESSION_NOT_FOUND"}`
409	O corpo trouxe `status`.	`{"error":"LIVE_SESSION_STATUS_NOT_UPDATABLE","detail":"status cannot be changed via update; use start/end"}`
400	Corpo inválido.	`{"error":"INVALID_BODY","detail":"..."}`

Apagar sessão ao vivo

Remove a sessão de vez, inclusive a vitrine de produtos e o chat dela, em qualquer estado. Para só desmarcar uma sessão que ainda não aconteceu, prefira cancel, que mantém o histórico.

DELETE/api/v1/admin/live-sessions/{id}Admin

Apaga uma sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Exemplo de requisição (Apagar sessão)

bash

curl -X DELETE "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Apagar sessão)

200Sessão apagada

json

{
  "message": "deleted"
}

Erros (Apagar sessão)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
404	Não existe sessão com esse `id`, ou o `id` não é um UUID.	`{"error":"LIVE_SESSION_NOT_FOUND"}`
400	A sessão não existe (id bem formado) ou o banco recusou.	`{"error":"LIVE_SESSION_DELETE_FAILED","detail":"live session 7ec34d19-64f7-4d36-92eb-dbb217448af7 not found"}`

Veja também

API atual/Referência completa/Sessões ao vivo

Alterar e apagar sessão

Altera título, horário e endereços de uma sessão ou a apaga.

Atualizar sessão ao vivo

Atualiza só os campos enviados. O estado não muda por aqui: para isso use start, end e cancel. Enviar status é recusado.

PUT/api/v1/admin/live-sessions/{id}Admin

Altera título, horário e endereços de uma sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

titlestring

Novo título.

descriptionstring

Nova descrição.

scheduled_atstring

Novo início previsto (RFC 3339).

embed_urlstring

Novo endereço da transmissão.

replay_urlstring

Endereço da gravação. Preencha depois que a sessão terminar para liberar a reprise e os clipes.

Exemplo de requisição (Atualizar sessão)

bash

curl -X PUT "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "replay_url": "https://www.youtube.com/watch?v=replay456"
}'

Resposta (Atualizar sessão)

200Sessão atualizada

json

{
  "id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "vendor_name": "Loja Seller Teste",
  "title": "Lançamento da coleção de verão",
  "description": "Ao vivo com ofertas exclusivas",
  "scheduled_at": "2026-12-05T18:00:00Z",
  "embed_url": "https://www.youtube.com/watch?v=abc123",
  "replay_url": "https://www.youtube.com/watch?v=replay456",
  "status": "scheduled",
  "viewer_count_peak": 0,
  "created_at": "2026-10-11T21:05:21.230055Z",
  "updated_at": "2026-10-11T21:05:21.230055Z"
}

Campos da resposta

iduuid

Identificador da sessão.

vendor_iduuid

Seller que apresenta a sessão.

vendor_namestring

Nome do seller, para exibir.

titlestring

Título.

descriptionstring

Descrição.

scheduled_atstring

Data e hora prevista de início, RFC 3339.

started_atstring

Quando foi ao ar. Ausente antes de começar.

ended_atstring

Quando terminou ou foi cancelada. Ausente enquanto não terminou.

embed_urlstring

Endereço da transmissão (YouTube, Vimeo, Mux...) que a vitrine coloca num player.

replay_urlstring

Endereço da gravação, usado depois que a sessão termina. Vazio se não houver.

statusstring

scheduled, live, ended ou cancelled.

viewer_count_peakinteger

Maior número de espectadores simultâneos.

created_atstring

Criação, RFC 3339.

updated_atstring

Última alteração, RFC 3339.

Erros (Atualizar sessão)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
404	Não existe sessão com esse `id`, ou o `id` não é um UUID.	`{"error":"LIVE_SESSION_NOT_FOUND"}`
409	O corpo trouxe `status`.	`{"error":"LIVE_SESSION_STATUS_NOT_UPDATABLE","detail":"status cannot be changed via update; use start/end"}`
400	Corpo inválido.	`{"error":"INVALID_BODY","detail":"..."}`

Apagar sessão ao vivo

Remove a sessão de vez, inclusive a vitrine de produtos e o chat dela, em qualquer estado. Para só desmarcar uma sessão que ainda não aconteceu, prefira cancel, que mantém o histórico.

DELETE/api/v1/admin/live-sessions/{id}Admin

Apaga uma sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Exemplo de requisição (Apagar sessão)

bash

curl -X DELETE "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Apagar sessão)

200Sessão apagada

json

{
  "message": "deleted"
}

Erros (Apagar sessão)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
404	Não existe sessão com esse `id`, ou o `id` não é um UUID.	`{"error":"LIVE_SESSION_NOT_FOUND"}`
400	A sessão não existe (id bem formado) ou o banco recusou.	`{"error":"LIVE_SESSION_DELETE_FAILED","detail":"live session 7ec34d19-64f7-4d36-92eb-dbb217448af7 not found"}`