Pular para o conteúdo
Entrar Lista de espera
Docs/Referência da API/Avisos/Marcar avisos como lidos

Marcar avisos como lidos

POST /v1/notifications/read escopo write

Marca avisos como lidos: ids (até 100) ou all: true. Ids que não são seus, ou que não existem, são ignorados, e marcar de novo não faz mal. Devolve marked (quantos mudaram) e o novo unreadCount.

CabeçalhosAuthorization: Bearer praeko_… e X-Praeko-Contract: en. Sempre envie os dois.

Parâmetros

Nome Onde Descrição
Idempotency-Key cabeçalho Chave de idempotência (1 a 255 caracteres visíveis, por exemplo um UUID). Repetir o MESMO pedido com a mesma chave, em até 24 h, devolve a resposta guardada (com Idempotent-Replayed: true) sem executar de novo; outro pedido com a mesma chave dá 422 idempotency_key_reuse; um pedido ainda em andamento dá 409 idempotency_in_progress. Erros 5xx não são guardados. A chave vale por workspace e por rota. Veja Repetir uma requisição.

Corpo da requisição

JSON. Campos obrigatórios precisam ir; os outros podem ser omitidos. Campo que não está na tabela é recusado. Envie ids ou all: true; um corpo sem nenhum dos dois dá 422 invalid_field.

Campo Tipo Descrição
ids (opcional) string[] Ids dos avisos a marcar (até 100). Pode ser omitido se enviar all: true. Até 100 itens.
all (opcional) verdadeiro/falso true marca todos os avisos não lidos de quem está logado.
Exemplo de corpo
{
  "all": true
}

Exemplo

curl -X POST "https://praeko.app/v1/notifications/read" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en" \
  -H "Content-Type: application/json" \
  -d '{
  "all": true
}'

Resposta

Status de sucesso Quando
200 Sucesso.
Resposta 200
{
  "marked": 1,
  "unreadCount": 0
}

Erros

Status code Quando
400 empty_body O corpo veio vazio.
400 invalid_json O corpo não é um objeto JSON.
413 body_too_large O corpo passa de 1 MB.
422 invalid_field Sem ids nem all: true, ids com mais de 100 itens ou campo desconhecido.
422 idempotency_key_reuse A Idempotency-Key já foi usada com outro pedido (método, caminho, query ou corpo diferentes).
409 idempotency_in_progress Um pedido com a mesma Idempotency-Key ainda está em andamento (repita em instantes).
409 idempotency_response_too_large A resposta original passou de 256 KB e não foi guardada; consulte o recurso por GET.

Erros de qualquer rota

Status code Quando
401 unauthorized Faltou o cabeçalho Authorization: Bearer ….
401 invalid_api_key A chave não existe.
401 revoked_api_key A chave foi revogada.
401 expired_api_key A chave expirou.
403 forbidden O escopo da chave não basta para esta rota (veja o selo de escopo).
429 rate_limited Passou do limite de requisições por minuto.

O corpo de todo erro é { "error": { "code", "message", "details"? } }. Veja todos os códigos.

Testar

Testar

O teste ao vivo usa a sua chave e a sua conta. Para quem não entrou, fica desligado.

Entre para testar
Dúvida ou erro nesta página? contato@praeko.appVer .md

Digite para buscar páginas, rotas e códigos de erro.