Dailybot | Plan · Notificações e relatórios

O catálogo de notificações, as chaves e o resumo diário de cada pessoa, as rotas de canal e os relatórios agendados da organização, e os canais em que publicam. Parte da API do Dailybot Plan (Beta).

Beta

Plan está em beta. Tudo o que está em /plan no aplicativo web, os comandos da CLI e da agent skill para projetos, metas, quadros e tarefas, e a API pública /v1/plan/ podem mudar antes da disponibilidade geral. Quer testar com sua equipe? Escreva para [email protected].

GET/v1/plan/notifications/catalog/BetaChave de APICLI Auth

O catálogo de notificações

Todos os tipos de notificação, pessoais e da organização: o único catálogo a partir do qual as configurações web, a CLI e a agent skill são renderizadas. scope é personal (uma chave que a pessoa define para si, por DM e/ou e-mail) ou org (um tipo que uma rota de canal pode publicar). Os valores key são identificadores estáveis em minúsculas; default é o que a pessoa recebe antes de mexer na chave; tipos immediate nunca ficam retidos pela janela de agrupamento.

Objeto NotificationKind

Nome	Tipo	Obrigatório	Descrição
key	string	Obrigatório	Identificador estável em minúsculas: o que `items[].kind` e os `kinds` de uma rota recebem.
scope	enum	Obrigatório	`personal` (uma chave que a pessoa define para si, DM e/ou e-mail) ou `org` (um tipo que uma rota pode publicar em um canal).
group	string	Obrigatório	A `groups[].key` a que pertence, para renderizar.
title	string	Obrigatório	—
description	string	Obrigatório	—
events	array<string>	Obrigatório	Os tipos de evento de tarefa que o produzem.
targeting	enum	Obrigatório	Quem alcança: `me`, `watched`, `content_author`, `project_members`, `scheduled` ou `org`.
supports	array<string>	Obrigatório	Os canais que pode usar: `chat`, `email`.
default	object	Obrigatório	`{chat, email}`: o que a pessoa recebe antes de mexer na chave.
immediate	boolean	Obrigatório	Um tipo imediato nunca fica retido pela janela de agrupamento.

Resposta

Nome	Tipo	Obrigatório	Descrição
groups	array<object>	Obrigatório	Linhas `{key, title}`, na ordem de exibição.
kinds	array<NotificationKind>	Obrigatório	Os objetos NotificationKind.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].

curl -sS "https://api.dailybot.com/v1/plan/notifications/catalog/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks notifications catalog

{
  "groups": [
    {
      "key": "my_work",
      "title": "My work"
    }
  ],
  "kinds": [
    {
      "key": "task_assigned",
      "scope": "personal",
      "group": "my_work",
      "title": "Assigned to me",
      "description": "Someone made me the owner of a task.",
      "events": [
        "task.owner_changed"
      ],
      "targeting": "me",
      "supports": [
        "chat",
        "email"
      ],
      "default": {
        "chat": true,
        "email": false
      },
      "immediate": true
    }
  ]
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

GET/v1/plan/me/notifications/BetaCLI Auth

Minhas chaves de notificação

As chaves efetivas de quem chama, um item por tipo pessoal, com valores chat / email: a chave guardada quando existe (stored: true), senão o padrão do catálogo (stored: false). destination diz para onde vão as notificações de chat: uma mensagem direta por padrão, ou um canal público que a pessoa escolheu. Uma pessoa nunca é notificada das próprias ações, digam o que disserem esses valores.

Objeto NotificationDestination

Nome	Tipo	Obrigatório	Descrição
type	enum	Obrigatório	`dm` (o padrão) ou `channel`.
channel	ChatChannel \| null	Obrigatório	O canal público quando `type` é `channel`. Veja ChatChannel.

Objeto ChatChannel

Nome	Tipo	Obrigatório	Descrição
external_id	string	Obrigatório	O id do canal na plataforma: o mesmo valor que `dailybot chat send --channel` recebe.
name	string	Obrigatório	Nome do canal.
type	enum	Obrigatório	Um de `channel` (público), `private_channel`, `group_chat`.

Objeto NotificationPreferenceItem

Nome	Tipo	Obrigatório	Descrição
kind	string	Obrigatório	A `key` do catálogo.
group	string	Obrigatório	—
title	string	Obrigatório	—
supports	array<string>	Obrigatório	`chat`, `email`.
default	object	Obrigatório	`{chat, email}` do catálogo.
stored	boolean	Obrigatório	`true` quando a pessoa definiu esta chave; `false` quando o valor é o padrão do catálogo.
chat	boolean	Obrigatório	Valor efetivo.
email	boolean	Obrigatório	Valor efetivo.

Resposta

Nome	Tipo	Obrigatório	Descrição
destination	NotificationDestination	Obrigatório	Um objeto NotificationDestination.
items	array<NotificationPreferenceItem>	Obrigatório	Uma linha por tipo pessoal: objetos NotificationPreferenceItem.
paused_until	datetime \| null	Obrigatório	Reservado; sempre `null` nesta versão.

Erros

Status	Quando
400	A credencial é uma key de agente ou da organização (`actor_required`); este endpoint exige uma pessoa.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Contas de convidado não podem usar o Plan (`guest_not_allowed`).

curl -sS "https://api.dailybot.com/v1/plan/me/notifications/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks notifications get --me

{
  "destination": {
    "type": "dm",
    "channel": null
  },
  "items": [
    {
      "kind": "task_assigned",
      "group": "my_work",
      "title": "Assigned to me",
      "supports": [
        "chat",
        "email"
      ],
      "default": {
        "chat": true,
        "email": false
      },
      "stored": true,
      "chat": true,
      "email": true
    }
  ],
  "paused_until": null
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Exige uma pessoa: chame com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal, que age como sua pessoa. Uma key de agente ou da organização recebe `400 actor_required`.

PUT/v1/plan/me/notifications/BetaCLI Auth

Alterar minhas chaves de notificação

Parcial: só os tipos e canais que você nomeia são gravados; todo o resto mantém o valor efetivo. Responde o corpo efetivo completo, igual ao GET. Um tipo desconhecido é 400 unknown_notification_kind e um campo desconhecido é 400 unknown_field (extra.parameter o nomeia). Um canal de destination precisa ser público (type: channel em GET /v1/plan/channels/); um privado é 400 channel_not_found, e notificações sobre trabalho só para membros continuam chegando por DM. paused_until está reservado: enviar um valor é 501 not_implemented.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Corpo da requisição

Nome	Tipo	Obrigatório	Descrição
destination	object	Opcional	`{type: "dm"}` ou `{type: "channel", channel: {external_id}}`.
items	array<object>	Opcional	Linhas `{kind, chat?, email?}`: a `key` do catálogo e os canais a definir. Omita um canal para deixá-lo como está.
paused_until	datetime \| null	Opcional	Reservado. Só `null` é aceito; uma data e hora é `501 not_implemented`.
agent_name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa (máx. 128 caracteres, vazio significa sem agente). Tem prioridade sobre o header `X-Dailybot-Agent-Name`. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
destination	NotificationDestination	Obrigatório	Um objeto NotificationDestination.
items	array<NotificationPreferenceItem>	Obrigatório	Uma linha por tipo pessoal: objetos NotificationPreferenceItem.
paused_until	datetime \| null	Obrigatório	Reservado; sempre `null` nesta versão.

Erros

Status	Quando
400	Um tipo desconhecido (`unknown_notification_kind`), um campo desconhecido (`unknown_field`), um canal que não é público ou não é conhecido (`channel_not_found`), uma key de agente ou da organização (`actor_required`), ou um nome de agente inválido (`invalid_agent_attribution`).
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Contas de convidado não podem usar o Plan (`guest_not_allowed`).

curl -sS -X PUT "https://api.dailybot.com/v1/plan/me/notifications/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "kind": "task_assigned",
      "email": true
    },
    {
      "kind": "comment_added",
      "chat": false
    }
  ]
}'

dailybot plan tasks notifications set --me task_assigned --email on

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:write`.
Limite de requisições: 60 escritas por minuto por ator.
Exige uma pessoa: chame com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal, que age como sua pessoa. Uma key de agente ou da organização recebe `400 actor_required`.

GET/v1/plan/notification-routes/BetaChave de APICLI AuthPaginação por número de página

Listar as rotas de canal da organização

Todas as rotas: um canal de chat, os tipos de notificação da organização que recebe e seu escopo (todo o espaço de trabalho, alguns quadros ou alguns projetos). viewer.can_manage diz se quem chama pode criar ou alterar rotas. Qualquer membro, e qualquer key, pode ler.

Parâmetros de consulta

Nome	Tipo	Obrigatório	Descrição
page	integer	Opcional	Número da página, começando em 1.
page_size	integer	Opcional	Linhas por página. Padrão 50, máximo 100. Valores fora do intervalo são ajustados, nunca rejeitados: pedir 500 retorna 100.

Objeto NotificationRoute

Nome	Tipo	Obrigatório	Descrição
uuid	uuid	Obrigatório	Identificador público estável.
name	string	Obrigatório	Nome da rota.
enabled	boolean	Obrigatório	Uma rota desativada mantém a configuração e não publica nada.
channel	ChatChannel	Obrigatório	Onde publica. Veja ChatChannel.
kinds	array<string>	Obrigatório	Os tipos de notificação da organização que recebe (valores `key` do catálogo).
scope	RouteScope	Obrigatório	Que trabalho cobre. Veja RouteScope.
created_by	UserRef \| null	Obrigatório	Quem a criou. Veja UserRef.
created_at	datetime \| null	Obrigatório	—
updated_at	datetime \| null	Obrigatório	—

Objeto RouteScope

Nome	Tipo	Obrigatório	Descrição
type	enum	Obrigatório	`all` (todo o espaço de trabalho), `boards` ou `projects`.
uuids	array<uuid>	Obrigatório	Os uuids de quadros ou projetos quando `type` não é `all`. Só quadros e projetos que todo o espaço de trabalho pode ver são aceitos.

Objeto RoutesViewer

Nome	Tipo	Obrigatório	Descrição
can_manage	boolean	Obrigatório	Se quem chama pode criar, alterar ou apagar rotas e relatórios agendados: um administrador da organização com uma credencial que pode escrever.

Objeto UserRef

Nome	Tipo	Obrigatório	Descrição
uuid	uuid	Obrigatório	Identificador público estável.
name	string	Opcional	Nome de exibição.
avatar_url	string \| null	Opcional	—
has_photo	boolean	Opcional	—

Resposta

Nome	Tipo	Obrigatório	Descrição
count	integer	Obrigatório	Número total de linhas.
next	uri	Obrigatório	URL da próxima página, ou `null`.
previous	uri	Obrigatório	URL da página anterior, ou `null`.
results	array<NotificationRoute>	Obrigatório	A página de objetos NotificationRoute.
viewer	RoutesViewer	Obrigatório	Um objeto RoutesViewer.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].

curl -sS "https://api.dailybot.com/v1/plan/notification-routes/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks routes list

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "00000000-0000-4000-8000-000000000021",
      "name": "Engineering channel",
      "enabled": true,
      "channel": {
        "external_id": "C0123ABC",
        "name": "engineering",
        "type": "channel"
      },
      "kinds": [
        "task_completed",
        "project_update_posted",
        "project_lead_changed"
      ],
      "scope": {
        "type": "boards",
        "uuids": [
          "00000000-0000-4000-8000-000000000002"
        ]
      },
      "created_by": {
        "uuid": "00000000-0000-4000-8000-000000000001",
        "name": "Ana"
      },
      "created_at": "2026-09-30T14:00:00Z",
      "updated_at": "2026-09-30T14:00:00Z"
    }
  ],
  "viewer": {
    "can_manage": true
  }
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

POST/v1/plan/notification-routes/BetaCLI Auth

Criar uma rota de canal

Somente administradores da organização. Uma rota publica os tipos de notificação da organização que você escolher (uma tarefa concluída, uma atualização de projeto, uma troca de líder…) em um canal de chat, para todo o espaço de trabalho ou para alguns quadros ou projetos. No máximo 10 rotas por organização. Aceita Idempotency-Key.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
Idempotency-Key	string	Opcional	Uma chave que você gera para esta intenção. Uma repetição com a mesma chave e o mesmo corpo retorna a primeira resposta sem um segundo efeito colateral e traz `Idempotency-Replayed: true`. As chaves são mantidas por 24 horas. A mesma chave com um corpo diferente é `409 idempotency_key_payload_mismatch`; uma repetição enquanto a primeira chamada ainda está em execução recebe `409 idempotency_in_progress` por até 120 segundos.
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Corpo da requisição

Nome	Tipo	Obrigatório	Descrição
name	string	Opcional	Nome da rota.
enabled	boolean	Opcional	`true` por padrão.
channel	object	Opcional	`{external_id}`: o id do canal na plataforma, como `GET /v1/plan/channels/` o lista. Ids desconhecidos são `400 channel_not_found`.
kinds	array<string>	Opcional	Tipos da organização do catálogo (`scope: org`). Qualquer outra coisa é `400 unknown_notification_kind`.
scope	RouteScope	Opcional	`{type, uuids}`. Um quadro ou projeto só para membros é `400 route_scope_not_org_visible` com `extra.uuids`: canais só recebem o que todo o espaço de trabalho pode ver.
agent_name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa (máx. 128 caracteres, vazio significa sem agente). Tem prioridade sobre o header `X-Dailybot-Agent-Name`. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	NotificationRoute	Obrigatório	Um objeto NotificationRoute.

Erros

Status	Quando
400	Um campo falhou na validação: `channel_not_found`, `unknown_notification_kind`, `route_scope_not_org_visible` (`extra.uuids`), `unknown_field`, ou `notification_routes_limit_reached` (`extra.limit`, 10 rotas). `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.

curl -sS -X POST "https://api.dailybot.com/v1/plan/notification-routes/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Engineering channel",
  "channel": {
    "external_id": "C0123ABC"
  },
  "kinds": [
    "task_completed",
    "project_update_posted",
    "project_lead_changed"
  ],
  "scope": {
    "type": "boards",
    "uuids": [
      "00000000-0000-4000-8000-000000000002"
    ]
  }
}'

dailybot plan tasks routes create --name "Engineering channel" --channel C0123ABC --kind task_completed --kind project_update_posted --board 00000000-0000-4000-8000-000000000002

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

GET/v1/plan/notification-routes/{route_id}/BetaChave de APICLI Auth

Obter uma rota de canal

Uma rota. Uma rota de outra organização é 404.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
route_id	uuid	Obrigatório	O uuid da rota.

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	NotificationRoute	Obrigatório	Um objeto NotificationRoute.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
404	A rota não existe na sua organização (`not_found`), nunca um 403.

curl -sS "https://api.dailybot.com/v1/plan/notification-routes/00000000-0000-4000-8000-000000000021/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks routes get 00000000-0000-4000-8000-000000000021

{
  "uuid": "00000000-0000-4000-8000-000000000021",
  "name": "Engineering channel",
  "enabled": true,
  "channel": {
    "external_id": "C0123ABC",
    "name": "engineering",
    "type": "channel"
  },
  "kinds": [
    "task_completed",
    "project_update_posted",
    "project_lead_changed"
  ],
  "scope": {
    "type": "boards",
    "uuids": [
      "00000000-0000-4000-8000-000000000002"
    ]
  },
  "created_by": {
    "uuid": "00000000-0000-4000-8000-000000000001",
    "name": "Ana"
  },
  "created_at": "2026-09-30T14:00:00Z",
  "updated_at": "2026-09-30T14:00:00Z"
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

PATCH/v1/plan/notification-routes/{route_id}/BetaCLI Auth

Alterar uma rota de canal

Somente administradores da organização. Parcial: só os campos enviados são gravados, com a mesma validação da criação.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
route_id	uuid	Obrigatório	O uuid da rota.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Corpo da requisição

Nome	Tipo	Obrigatório	Descrição
name	string	Opcional	Nome da rota.
enabled	boolean	Opcional	`true` por padrão.
channel	object	Opcional	`{external_id}`: o id do canal na plataforma, como `GET /v1/plan/channels/` o lista. Ids desconhecidos são `400 channel_not_found`.
kinds	array<string>	Opcional	Tipos da organização do catálogo (`scope: org`). Qualquer outra coisa é `400 unknown_notification_kind`.
scope	RouteScope	Opcional	`{type, uuids}`. Um quadro ou projeto só para membros é `400 route_scope_not_org_visible` com `extra.uuids`: canais só recebem o que todo o espaço de trabalho pode ver.
agent_name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa (máx. 128 caracteres, vazio significa sem agente). Tem prioridade sobre o header `X-Dailybot-Agent-Name`. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	NotificationRoute	Obrigatório	Um objeto NotificationRoute.

Erros

Status	Quando
400	Um campo falhou na validação: `channel_not_found`, `unknown_notification_kind`, `route_scope_not_org_visible` (`extra.uuids`), `unknown_field`, ou `notification_routes_limit_reached` (`extra.limit`, 10 rotas). `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.
404	A rota não existe na sua organização (`not_found`), nunca um 403.

curl -sS -X PATCH "https://api.dailybot.com/v1/plan/notification-routes/00000000-0000-4000-8000-000000000021/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": false
}'

dailybot plan tasks routes update 00000000-0000-4000-8000-000000000021 --disable

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

DELETE/v1/plan/notification-routes/{route_id}/BetaCLI Auth

Apagar uma rota de canal

Somente administradores da organização. O canal para de receber na hora. Responde 204.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
route_id	uuid	Obrigatório	O uuid da rota.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Erros

Status	Quando
400	A validação falhou; o `code` da resposta indica qual campo. `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.
404	A rota não existe na sua organização (`not_found`), nunca um 403.

curl -sS -X DELETE "https://api.dailybot.com/v1/plan/notification-routes/00000000-0000-4000-8000-000000000021/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks routes delete 00000000-0000-4000-8000-000000000021

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

POST/v1/plan/notification-routes/{route_id}/send-test/BetaCLI Auth

Publicar uma mensagem de teste no canal de uma rota, ou pré-visualizá-la

Somente administradores da organização. Com ?dry_run=true a amostra é renderizada e o canal resolvido, e nada é enviado nem registrado. Sem ele, uma mensagem é publicada e registrada como qualquer publicação da rota.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
route_id	uuid	Obrigatório	O uuid da rota.

Parâmetros de consulta

Nome	Tipo	Obrigatório	Descrição
dry_run	boolean	Opcional	`true` só renderiza e resolve; nada é enviado nem registrado. Falha de forma segura: qualquer valor diferente de `0`, `false`, `no` ou `off` é um ensaio.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
dry_run	boolean	Obrigatório	Ecoa a requisição: `true` quando nada foi enviado.
channel	ChatChannel	Obrigatório	Um objeto ChatChannel.
text	string	Obrigatório	A mensagem de amostra renderizada.
sent	boolean	Obrigatório	`false` em um ensaio.
status	string	Opcional	O status da entrega quando enviada.
delivery_uuid	uuid \| null	Opcional	O registro de entrega quando enviada; veja o endpoint de entregas.

Erros

Status	Quando
400	A validação falhou; o `code` da resposta indica qual campo. `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.
404	A rota não existe na sua organização (`not_found`), nunca um 403.

curl -sS -X POST "https://api.dailybot.com/v1/plan/notification-routes/00000000-0000-4000-8000-000000000021/send-test/?dry_run=true" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks routes send-test 00000000-0000-4000-8000-000000000021 --dry-run

{
  "dry_run": true,
  "channel": {
    "external_id": "C0123ABC",
    "name": "engineering",
    "type": "channel"
  },
  "text": "Test message from Dailybot Plan for the route \"Engineering channel\".",
  "sent": false
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

GET/v1/plan/notification-routes/{route_id}/deliveries/BetaChave de APICLI AuthPaginação por número de página

As últimas entregas de uma rota

As 20 entregas mais recentes, da mais nova para a mais antiga: sent, failed (com um código de motivo) ou skipped (not_org_visible, rate_limited). Nunca o texto da mensagem.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
route_id	uuid	Obrigatório	O uuid da rota.

Objeto DeliveryRecord

Nome	Tipo	Obrigatório	Descrição
uuid	uuid	Obrigatório	—
status	enum	Obrigatório	`sent`, `failed` (veja `error`) ou `skipped` (`not_org_visible`, `rate_limited`).
channel	enum	Obrigatório	`chat` ou `email`.
error	string \| null	Obrigatório	Um código de motivo quando a entrega falhou ou foi pulada. Nunca o texto da mensagem.
message_id	string \| null	Obrigatório	O id da mensagem na plataforma quando foi publicada.
created_at	datetime	Obrigatório	—

Resposta

Nome	Tipo	Obrigatório	Descrição
count	integer	Obrigatório	Número total de linhas.
next	uri	Obrigatório	URL da próxima página, ou `null`.
previous	uri	Obrigatório	URL da página anterior, ou `null`.
results	array<DeliveryRecord>	Obrigatório	Os objetos DeliveryRecord.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
404	A rota não existe na sua organização (`not_found`), nunca um 403.

curl -sS "https://api.dailybot.com/v1/plan/notification-routes/00000000-0000-4000-8000-000000000021/deliveries/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks routes deliveries 00000000-0000-4000-8000-000000000021

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

GET/v1/plan/channels/BetaChave de APICLI AuthPaginação por número de página

Buscar os canais de chat em que rotas e relatórios podem publicar

Os canais da plataforma conectada, ordenados por nome, como uma página. search é uma substring do nome sem distinguir maiúsculas. platform nomeia a plataforma (slack, msteams, discord, google_chat); sem plataforma de chat conectada a resposta é 400 platform_not_connected. Administradores da organização veem canais privados em que o bot está; os demais só veem canais públicos (um canal privado está ausente, não proibido). type=channel responde só canais públicos, para todos: o que um destino pessoal de notificações precisa ser.

Parâmetros de consulta

Nome	Tipo	Obrigatório	Descrição
search	string	Opcional	Substring do nome do canal, sem distinguir maiúsculas.
type	string	Opcional	`channel` responde só canais públicos, para todos. Sem ele, administradores da organização também veem canais privados em que o bot está.
page	integer	Opcional	Número da página, começando em 1.
page_size	integer	Opcional	Linhas por página. Padrão 50, máximo 100. Valores fora do intervalo são ajustados, nunca rejeitados: pedir 500 retorna 100.

Resposta

Nome	Tipo	Obrigatório	Descrição
count	integer	Obrigatório	Número total de linhas.
next	uri	Obrigatório	URL da próxima página, ou `null`.
previous	uri	Obrigatório	URL da página anterior, ou `null`.
results	array<ChatChannel>	Obrigatório	A página de objetos ChatChannel.
platform	string	Obrigatório	`slack`, `msteams`, `discord` ou `google_chat`.

Erros

Status	Quando
400	Não há plataforma de chat conectada (`platform_not_connected`), ou `type` ou um valor de paginação não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].

curl -sS "https://api.dailybot.com/v1/plan/channels/?search=eng&type=channel" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks channels search eng --type channel

{
  "count": 1,
  "next": null,
  "previous": null,
  "platform": "slack",
  "results": [
    {
      "external_id": "C0123ABC",
      "name": "engineering",
      "type": "channel"
    }
  ]
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

GET/v1/plan/reports/BetaChave de APICLI AuthPaginação por número de página

Listar os relatórios agendados da organização

Todos os relatórios agendados com seu tipo (daily, week_start, week_end), weekdays ISO (segunda = 1), time local no seu timezone IANA, canal, destinatários de e-mail, escopo e última execução. viewer.can_manage diz se quem chama pode alterá-los (um administrador da organização).

Parâmetros de consulta

Nome	Tipo	Obrigatório	Descrição
page	integer	Opcional	Número da página, começando em 1.
page_size	integer	Opcional	Linhas por página. Padrão 50, máximo 100. Valores fora do intervalo são ajustados, nunca rejeitados: pedir 500 retorna 100.

Objeto ReportSchedule

Nome	Tipo	Obrigatório	Descrição
uuid	uuid	Obrigatório	—
name	string	Obrigatório	—
kind	enum	Obrigatório	`daily`, `week_start` ou `week_end`.
enabled	boolean	Obrigatório	—
weekdays	array<integer>	Obrigatório	Dias ISO, segunda = 1. Um relatório `week_start` ou `week_end` tem exatamente um.
time	string	Obrigatório	`HH:MM`, 24 horas, em `timezone`.
timezone	string	Obrigatório	Nome IANA.
channel	ChatChannel \| null	Obrigatório	Onde publica, ou `null` se vai só por e-mail. Veja ChatChannel.
email_recipients	array<UserRef>	Obrigatório	Veja UserRef.
scope	RouteScope	Obrigatório	Veja RouteScope.
created_by	UserRef \| null	Obrigatório	—
last_run	ReportRun \| null	Obrigatório	Veja ReportRun.
created_at	datetime \| null	Obrigatório	—
updated_at	datetime \| null	Obrigatório	—

Objeto ReportRun

Nome	Tipo	Obrigatório	Descrição
uuid	uuid	Obrigatório	—
period_key	string	Obrigatório	O período que a execução cobriu, por exemplo uma data ou uma semana ISO.
scheduled_for	datetime	Obrigatório	—
sent_at	datetime \| null	Obrigatório	—
status	enum	Obrigatório	`sent`, `failed` (veja `error`) ou `skipped_empty`.
error	string \| null	Obrigatório	Um código de motivo quando falhou.
channel_message_id	string \| null	Obrigatório	—
email_count	integer	Obrigatório	Quantos e-mails foram enviados.
is_test	boolean	Obrigatório	`true` para um envio de teste; não conta como a execução do período.

Resposta

Nome	Tipo	Obrigatório	Descrição
count	integer	Obrigatório	Número total de linhas.
next	uri	Obrigatório	URL da próxima página, ou `null`.
previous	uri	Obrigatório	URL da página anterior, ou `null`.
results	array<ReportSchedule>	Obrigatório	A página de objetos ReportSchedule.
viewer	RoutesViewer	Obrigatório	Um objeto RoutesViewer.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].

curl -sS "https://api.dailybot.com/v1/plan/reports/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks reports list

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "00000000-0000-4000-8000-000000000022",
      "name": "Friday wrap-up",
      "kind": "week_end",
      "enabled": true,
      "weekdays": [
        5
      ],
      "time": "16:00",
      "timezone": "America/Bogota",
      "channel": {
        "external_id": "C0123ABC",
        "name": "engineering",
        "type": "channel"
      },
      "email_recipients": [
        {
          "uuid": "00000000-0000-4000-8000-000000000001",
          "name": "Ana"
        }
      ],
      "scope": {
        "type": "all",
        "uuids": []
      },
      "created_by": {
        "uuid": "00000000-0000-4000-8000-000000000001",
        "name": "Ana"
      },
      "last_run": null,
      "created_at": "2026-09-30T14:00:00Z",
      "updated_at": "2026-09-30T14:00:00Z"
    }
  ],
  "viewer": {
    "can_manage": true
  }
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

POST/v1/plan/reports/BetaCLI Auth

Agendar um relatório

Somente administradores da organização. Um relatório diário diz o que se espera hoje e quem é responsável; um de início de semana olha a semana que começa; um de fim de semana diz o que fechou, o que está em risco e o que não fechou. É publicado em um canal, vai por e-mail às pessoas que você nomear, ou ambos, nos dias da semana e na hora local que escolher. No máximo 10 relatórios agendados por organização. Aceita Idempotency-Key.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
Idempotency-Key	string	Opcional	Uma chave que você gera para esta intenção. Uma repetição com a mesma chave e o mesmo corpo retorna a primeira resposta sem um segundo efeito colateral e traz `Idempotency-Replayed: true`. As chaves são mantidas por 24 horas. A mesma chave com um corpo diferente é `409 idempotency_key_payload_mismatch`; uma repetição enquanto a primeira chamada ainda está em execução recebe `409 idempotency_in_progress` por até 120 segundos.
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Corpo da requisição

Nome	Tipo	Obrigatório	Descrição
name	string	Opcional	Nome do relatório agendado.
kind	enum	Opcional	`daily` (o que se espera hoje, com responsáveis), `week_start` (a semana que começa) ou `week_end` (o que fechou, o que está em risco, o que não fechou).
enabled	boolean	Opcional	`true` por padrão.
weekdays	array<integer>	Opcional	Dias ISO, segunda = 1 … domingo = 7. Um relatório `daily` aceita qualquer conjunto (por exemplo `[1,2,3,4,5]`); `week_start` e `week_end` aceitam exatamente um.
time	string	Opcional	`HH:MM`, 24 horas, em `timezone`.
timezone	string	Opcional	Nome IANA. Por padrão, o da organização.
channel	object \| null	Opcional	`{external_id}` do canal onde publicar, ou `null` se vai só por e-mail. Um relatório agendado precisa de um canal, destinatários de e-mail, ou ambos.
email_recipients	array<uuid>	Opcional	Uuids de usuários que o recebem por e-mail. `[]` os limpa.
scope	RouteScope	Opcional	`{type, uuids}`: todo o espaço de trabalho, alguns quadros ou alguns projetos. Trabalho só para membros é recusado com `400 route_scope_not_org_visible`.
agent_name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa (máx. 128 caracteres, vazio significa sem agente). Tem prioridade sobre o header `X-Dailybot-Agent-Name`. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	ReportSchedule	Obrigatório	Um objeto ReportSchedule.

Erros

Status	Quando
400	Um campo do relatório agendado é inválido (`invalid_schedule`, `extra.parameter` é `weekdays`, `time`, `timezone`, `channel` ou `kind`), o canal é desconhecido (`channel_not_found`), o escopo nomeia trabalho só para membros (`route_scope_not_org_visible`), um campo é desconhecido (`unknown_field`), ou a organização já tem 10 relatórios agendados (`report_schedules_limit_reached`, `extra.limit`). `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.

curl -sS -X POST "https://api.dailybot.com/v1/plan/reports/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Friday wrap-up",
  "kind": "week_end",
  "weekdays": [
    5
  ],
  "time": "16:00",
  "timezone": "America/Bogota",
  "channel": {
    "external_id": "C0123ABC"
  },
  "scope": {
    "type": "all",
    "uuids": []
  }
}'

dailybot plan tasks reports create --name "Friday wrap-up" --kind week_end --weekday 5 --time 16:00 --channel C0123ABC

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

GET/v1/plan/reports/{report_id}/BetaChave de APICLI Auth

Obter um relatório agendado

Um relatório agendado. Um de outra organização é 404.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
report_id	uuid	Obrigatório	O uuid do relatório agendado.

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	ReportSchedule	Obrigatório	Um objeto ReportSchedule.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
404	O relatório agendado não existe na sua organização (`not_found`), nunca um 403.

curl -sS "https://api.dailybot.com/v1/plan/reports/00000000-0000-4000-8000-000000000022/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks reports get 00000000-0000-4000-8000-000000000022

{
  "uuid": "00000000-0000-4000-8000-000000000022",
  "name": "Friday wrap-up",
  "kind": "week_end",
  "enabled": true,
  "weekdays": [
    5
  ],
  "time": "16:00",
  "timezone": "America/Bogota",
  "channel": {
    "external_id": "C0123ABC",
    "name": "engineering",
    "type": "channel"
  },
  "email_recipients": [
    {
      "uuid": "00000000-0000-4000-8000-000000000001",
      "name": "Ana"
    }
  ],
  "scope": {
    "type": "all",
    "uuids": []
  },
  "created_by": {
    "uuid": "00000000-0000-4000-8000-000000000001",
    "name": "Ana"
  },
  "last_run": null,
  "created_at": "2026-09-30T14:00:00Z",
  "updated_at": "2026-09-30T14:00:00Z"
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

PATCH/v1/plan/reports/{report_id}/BetaCLI Auth

Alterar um relatório agendado

Somente administradores da organização. Parcial, com a mesma validação da criação. channel: null limpa o canal e email_recipients: [] limpa os destinatários; limpar os dois é 400 invalid_schedule (extra.parameter: "channel").

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
report_id	uuid	Obrigatório	O uuid do relatório agendado.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Corpo da requisição

Nome	Tipo	Obrigatório	Descrição
name	string	Opcional	Nome do relatório agendado.
kind	enum	Opcional	`daily` (o que se espera hoje, com responsáveis), `week_start` (a semana que começa) ou `week_end` (o que fechou, o que está em risco, o que não fechou).
enabled	boolean	Opcional	`true` por padrão.
weekdays	array<integer>	Opcional	Dias ISO, segunda = 1 … domingo = 7. Um relatório `daily` aceita qualquer conjunto (por exemplo `[1,2,3,4,5]`); `week_start` e `week_end` aceitam exatamente um.
time	string	Opcional	`HH:MM`, 24 horas, em `timezone`.
timezone	string	Opcional	Nome IANA. Por padrão, o da organização.
channel	object \| null	Opcional	`{external_id}` do canal onde publicar, ou `null` se vai só por e-mail. Um relatório agendado precisa de um canal, destinatários de e-mail, ou ambos.
email_recipients	array<uuid>	Opcional	Uuids de usuários que o recebem por e-mail. `[]` os limpa.
scope	RouteScope	Opcional	`{type, uuids}`: todo o espaço de trabalho, alguns quadros ou alguns projetos. Trabalho só para membros é recusado com `400 route_scope_not_org_visible`.
agent_name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa (máx. 128 caracteres, vazio significa sem agente). Tem prioridade sobre o header `X-Dailybot-Agent-Name`. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	ReportSchedule	Obrigatório	Um objeto ReportSchedule.

Erros

Status	Quando
400	Um campo do relatório agendado é inválido (`invalid_schedule`, `extra.parameter` é `weekdays`, `time`, `timezone`, `channel` ou `kind`), o canal é desconhecido (`channel_not_found`), o escopo nomeia trabalho só para membros (`route_scope_not_org_visible`), um campo é desconhecido (`unknown_field`), ou a organização já tem 10 relatórios agendados (`report_schedules_limit_reached`, `extra.limit`). `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.
404	O relatório agendado não existe na sua organização (`not_found`), nunca um 403.

curl -sS -X PATCH "https://api.dailybot.com/v1/plan/reports/00000000-0000-4000-8000-000000000022/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "weekdays": [
    1
  ],
  "kind": "week_start",
  "time": "09:00"
}'

dailybot plan tasks reports update 00000000-0000-4000-8000-000000000022 --kind week_start --weekday 1 --time 09:00

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

DELETE/v1/plan/reports/{report_id}/BetaCLI Auth

Apagar um relatório agendado

Somente administradores da organização. Suas execuções vão junto. Responde 204.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
report_id	uuid	Obrigatório	O uuid do relatório agendado.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Erros

Status	Quando
400	A validação falhou; o `code` da resposta indica qual campo. `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.
404	O relatório agendado não existe na sua organização (`not_found`), nunca um 403.

curl -sS -X DELETE "https://api.dailybot.com/v1/plan/reports/00000000-0000-4000-8000-000000000022/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks reports delete 00000000-0000-4000-8000-000000000022

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

GET/v1/plan/reports/{report_id}/preview/BetaChave de APICLI Auth

Pré-visualizar um relatório agendado com dados reais

O relatório como seria enviado agora: o mesmo ReportDocument a partir do qual a mensagem de chat e o e-mail são renderizados. Relatórios da organização só incluem quadros e projetos que todo o espaço de trabalho pode ver.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
report_id	uuid	Obrigatório	O uuid do relatório agendado.

Objeto ReportDocument

Nome	Tipo	Obrigatório	Descrição
kind	enum	Obrigatório	`daily`, `week_start`, `week_end` ou `personal_daily`.
locale	string	Obrigatório	—
header	object	Obrigatório	`{title, period_key, period_label, scope}`.
sections	array<ReportSection>	Obrigatório	Veja ReportSection.
empty	boolean	Obrigatório	`true` quando nenhuma seção tem itens.
narrative	string	Opcional	Um parágrafo curto de resumo, opcional.

Objeto ReportSection

Nome	Tipo	Obrigatório	Descrição
key	string	Obrigatório	Chave estável da seção, por exemplo `closed`, `at_risk`, `due_today`.
title	string	Obrigatório	—
count	integer	Obrigatório	—
empty	boolean	Obrigatório	—
items	array<ReportItem>	Obrigatório	Veja ReportItem.

Objeto ReportItem

Nome	Tipo	Obrigatório	Descrição
type	enum	Obrigatório	`task`, `project`, `milestone`, `goal` ou `text`.
uuid	string	Obrigatório	—
key	string	Opcional	A chave da tarefa, como `ENG-142`, quando o item é uma tarefa.
title	string	Obrigatório	—
url	string	Obrigatório	Link direto para o aplicativo web.
owner	UserRef	Opcional	—
due_date	date	Opcional	—
state	string	Opcional	—
category	string	Opcional	—
health	string	Opcional	—
badges	array<string>	Obrigatório	Marcas curtas como `overdue` ou `blocked`.

Objeto UserRef

Nome	Tipo	Obrigatório	Descrição
uuid	uuid	Obrigatório	Identificador público estável.
name	string	Opcional	Nome de exibição.
avatar_url	string \| null	Opcional	—
has_photo	boolean	Opcional	—

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	ReportDocument	Obrigatório	Um objeto ReportDocument.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
404	O relatório agendado não existe na sua organização (`not_found`), nunca um 403.

curl -sS "https://api.dailybot.com/v1/plan/reports/00000000-0000-4000-8000-000000000022/preview/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks reports preview 00000000-0000-4000-8000-000000000022

{
  "kind": "week_end",
  "locale": "en",
  "header": {
    "title": "Week 40 wrap-up",
    "period_key": "2026-W40",
    "period_label": "Sep 28 \u2013 Oct 2",
    "scope": {
      "type": "all"
    }
  },
  "sections": [
    {
      "key": "closed",
      "title": "Closed this week",
      "count": 1,
      "empty": false,
      "items": [
        {
          "type": "task",
          "uuid": "00000000-0000-4000-8000-000000000011",
          "key": "ENG-142",
          "title": "Ship the onboarding checklist",
          "url": "https://app.dailybot.com/tasks/ENG-142",
          "owner": {
            "uuid": "00000000-0000-4000-8000-000000000001",
            "name": "Ana"
          },
          "due_date": "2026-10-01",
          "state": "Done",
          "category": "done",
          "badges": []
        }
      ]
    },
    {
      "key": "at_risk",
      "title": "At risk",
      "count": 0,
      "empty": true,
      "items": []
    }
  ],
  "empty": false
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

POST/v1/plan/reports/{report_id}/send-test/BetaCLI Auth

Enviar agora um relatório agendado como teste, ou pré-visualizar o que seria enviado

Somente administradores da organização. Com ?dry_run=true o documento, o canal e os destinatários são respondidos e nada é enviado. Sem ele, o relatório é enviado agora e registrado como execução de teste (is_test: true); não conta como a execução do período.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
report_id	uuid	Obrigatório	O uuid do relatório agendado.

Parâmetros de consulta

Nome	Tipo	Obrigatório	Descrição
dry_run	boolean	Opcional	`true` só renderiza e resolve; nada é enviado nem registrado. Falha de forma segura: qualquer valor diferente de `0`, `false`, `no` ou `off` é um ensaio.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
dry_run	boolean	Obrigatório	Ecoa a requisição: `true` quando nada foi enviado.
document	ReportDocument	Obrigatório	Um objeto ReportDocument.
channel	ChatChannel \| null	Obrigatório	Um objeto ChatChannel.
email_recipients	array<UserRef>	Obrigatório	Os objetos UserRef.
sent	boolean	Obrigatório	`false` em um ensaio.
run	ReportRun	Opcional	A execução de teste quando enviada. Veja ReportRun.

Erros

Status	Quando
400	A validação falhou; o `code` da resposta indica qual campo. `invalid_agent_attribution` significa que o nome do agente não é válido.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Você não é administrador da organização (`insufficient_scope`), ou é convidado (`guest_not_allowed`). Uma key de agente ou da organização também é recusada aqui.
404	O relatório agendado não existe na sua organização (`not_found`), nunca um 403.

curl -sS -X POST "https://api.dailybot.com/v1/plan/reports/00000000-0000-4000-8000-000000000022/send-test/?dry_run=true" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks reports send-test 00000000-0000-4000-8000-000000000022 --dry-run

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:admin` — escritas em contêineres. Um membro não convidado pode chamá-lo com uma sessão iniciada ou uma API key pessoal (uma key com scopes de Plan explícitos precisa de `tasks:write`, que o cobre); uma key de agente ou da organização recebe `403 insufficient_scope`.
Limite de requisições: 60 escritas por minuto por ator.
Somente administradores da organização, com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal. Qualquer membro e qualquer key pode ler.

GET/v1/plan/reports/{report_id}/runs/BetaChave de APICLI AuthPaginação por número de página

As últimas execuções de um relatório agendado

As 20 execuções mais recentes, da mais nova para a mais antiga: sent, failed (com um código de motivo) ou skipped_empty. Envios de teste levam is_test: true.

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
report_id	uuid	Obrigatório	O uuid do relatório agendado.

Resposta

Nome	Tipo	Obrigatório	Descrição
count	integer	Obrigatório	Número total de linhas.
next	uri	Obrigatório	URL da próxima página, ou `null`.
previous	uri	Obrigatório	URL da página anterior, ou `null`.
results	array<ReportRun>	Obrigatório	As objetos ReportRun.

Erros

Status	Quando
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
404	O relatório agendado não existe na sua organização (`not_found`), nunca um 403.

curl -sS "https://api.dailybot.com/v1/plan/reports/00000000-0000-4000-8000-000000000022/runs/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY"

dailybot plan tasks reports runs 00000000-0000-4000-8000-000000000022

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Funciona com uma sessão iniciada, um token de usuário da CLI, uma API key pessoal, ou uma key de agente ou da organização. Uma key pessoal vê o que sua pessoa vê; uma key de agente ou da organização atua como um ator de sistema e vê apenas quadros visíveis para a organização.

GET/v1/plan/me/briefing/BetaCLI Auth

Minhas configurações do resumo diário

As configurações do resumo diário de quem chama, com valores efetivos. Sem nada guardado, a resposta é o padrão: os dias úteis da pessoa (segunda a sexta se ela nunca os mudou), 09:00 no próprio fuso horário (timezone_is_default: true), chat ligado, e-mail desligado, enabled: false. A parte de chat é sempre uma mensagem direta, nunca o canal de notificações da pessoa: o resumo inclui também o trabalho só para membros.

Resposta

Nome	Tipo	Obrigatório	Descrição
enabled	boolean	Obrigatório	Se o resumo é enviado ou não.
weekdays	array<integer>	Obrigatório	Dias ISO, segunda = 1.
time	string	Obrigatório	`HH:MM`, 24 horas, em `timezone`.
timezone	string	Obrigatório	Nome IANA.
timezone_is_default	boolean	Obrigatório	`true` quando o fuso horário é o da pessoa e não um que ela definiu aqui.
chat	boolean	Obrigatório	Entregar por mensagem direta.
email	boolean	Obrigatório	Entregar por e-mail.
skip_when_empty	boolean	Obrigatório	Pular o resumo em um dia sem nada a dizer.
effective	boolean	Obrigatório	`true` quando os dias são os dias úteis padrão da pessoa e não um conjunto guardado aqui.
last_sent_at	datetime \| null	Obrigatório	Quando o resumo foi enviado pela última vez, ou `null`.

Erros

Status	Quando
400	A credencial é uma key de agente ou da organização (`actor_required`); este endpoint exige uma pessoa.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Contas de convidado não podem usar o Plan (`guest_not_allowed`).

curl -sS "https://api.dailybot.com/v1/plan/me/briefing/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks briefing get

{
  "enabled": true,
  "weekdays": [
    1,
    2,
    3,
    4,
    5
  ],
  "time": "09:00",
  "timezone": "America/Bogota",
  "timezone_is_default": true,
  "chat": true,
  "email": false,
  "skip_when_empty": true,
  "effective": true,
  "last_sent_at": "2026-09-30T14:00:00Z"
}

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Exige uma pessoa: chame com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal, que age como sua pessoa. Uma key de agente ou da organização recebe `400 actor_required`.

PUT/v1/plan/me/briefing/BetaCLI Auth

Alterar meu resumo diário

Parcial: só os campos enviados são gravados. weekdays são ISO 1..7, time é HH:MM, timezone é um nome IANA (opcional: a primeira gravação guarda o da pessoa). Pelo menos um de chat e email precisa ficar ligado. As recusas são 400 invalid_schedule (extra.parameter) e 400 unknown_field. Responde o corpo efetivo completo.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Corpo da requisição

Nome	Tipo	Obrigatório	Descrição
enabled	boolean	Opcional	Se o resumo é enviado ou não.
weekdays	array<integer>	Opcional	Dias ISO, segunda = 1 … domingo = 7.
time	string	Opcional	`HH:MM`, 24 horas.
timezone	string	Opcional	Nome IANA.
chat	boolean	Opcional	Entregar por mensagem direta.
email	boolean	Opcional	Entregar por e-mail.
skip_when_empty	boolean	Opcional	Pular o resumo em um dia sem nada a dizer.
agent_name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa (máx. 128 caracteres, vazio significa sem agente). Tem prioridade sobre o header `X-Dailybot-Agent-Name`. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
enabled	boolean	Obrigatório	Se o resumo é enviado ou não.
weekdays	array<integer>	Obrigatório	Dias ISO, segunda = 1.
time	string	Obrigatório	`HH:MM`, 24 horas, em `timezone`.
timezone	string	Obrigatório	Nome IANA.
timezone_is_default	boolean	Obrigatório	`true` quando o fuso horário é o da pessoa e não um que ela definiu aqui.
chat	boolean	Obrigatório	Entregar por mensagem direta.
email	boolean	Obrigatório	Entregar por e-mail.
skip_when_empty	boolean	Obrigatório	Pular o resumo em um dia sem nada a dizer.
effective	boolean	Obrigatório	`true` quando os dias são os dias úteis padrão da pessoa e não um conjunto guardado aqui.
last_sent_at	datetime \| null	Obrigatório	Quando o resumo foi enviado pela última vez, ou `null`.

Erros

Status	Quando
400	Um campo é inválido (`invalid_schedule`, `extra.parameter` o nomeia), desconhecido (`unknown_field`), os dois canais estão desligados, a credencial é uma key de agente ou da organização (`actor_required`), ou o nome do agente é inválido (`invalid_agent_attribution`).
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Contas de convidado não podem usar o Plan (`guest_not_allowed`).

curl -sS -X PUT "https://api.dailybot.com/v1/plan/me/briefing/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "weekdays": [
    1,
    2,
    3,
    4,
    5
  ],
  "time": "08:30",
  "email": true
}'

dailybot plan tasks briefing set --enable --weekday 1,2,3,4,5 --time 08:30 --email on

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:write`.
Limite de requisições: 60 escritas por minuto por ator.
Exige uma pessoa: chame com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal, que age como sua pessoa. Uma key de agente ou da organização recebe `400 actor_required`.

GET/v1/plan/me/briefing/preview/BetaCLI Auth

Pré-visualizar o resumo de hoje

O resumo de hoje para quem chama, renderizado agora: o ReportDocument personal_daily com o que está atrasado, vence hoje, está em andamento, bloqueado e a seguir, as menções não lidas e os projetos que a pessoa lidera.

Resposta

Nome	Tipo	Obrigatório	Descrição
(body)	ReportDocument	Obrigatório	Um objeto ReportDocument.

Erros

Status	Quando
400	A credencial é uma key de agente ou da organização (`actor_required`); este endpoint exige uma pessoa.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Contas de convidado não podem usar o Plan (`guest_not_allowed`).

curl -sS "https://api.dailybot.com/v1/plan/me/briefing/preview/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks briefing preview

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:read`.
Limite de requisições: 120 leituras por minuto por ator.
Exige uma pessoa: chame com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal, que age como sua pessoa. Uma key de agente ou da organização recebe `400 actor_required`.

POST/v1/plan/me/briefing/send-test/BetaCLI Auth

Enviar o resumo de hoje para mim agora, ou pré-visualizá-lo

Com ?dry_run=true nada é enviado. Sem ele, o resumo de hoje vai para quem chama por mensagem direta e/ou e-mail, conforme as configurações.

Parâmetros de consulta

Nome	Tipo	Obrigatório	Descrição
dry_run	boolean	Opcional	`true` só renderiza e resolve; nada é enviado nem registrado. Falha de forma segura: qualquer valor diferente de `0`, `false`, `no` ou `off` é um ensaio.

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
X-Dailybot-Agent-Name	string	Opcional	O nome do agente que executou esta escrita em nome da pessoa. Use-o em escritas multipart e sem corpo (DELETE, arquivar, restaurar); em escritas JSON envie o campo `agent_name` do corpo, que vence se os dois vierem. Codifique o valor em percent-encoding (UTF-8). Caracteres de controle são removidos; um valor em branco significa sem agente. Mais de 128 caracteres, ou um valor que não pode ser decodificado, é `400 invalid_agent_attribution` (nunca é truncado). Uma chave do tipo agente, que não está ligada a uma pessoa, recebe `400 invalid_agent_attribution` se enviá-lo. O selo nunca altera uma resposta de permissão. Veja Atribuição de agente.

Resposta

Nome	Tipo	Obrigatório	Descrição
dry_run	boolean	Obrigatório	Ecoa a requisição: `true` quando nada foi enviado.
document	ReportDocument	Obrigatório	Um objeto ReportDocument.
sent	boolean	Obrigatório	`false` em um ensaio.

Erros

Status	Quando
400	A credencial é uma key de agente ou da organização (`actor_required`); este endpoint exige uma pessoa.
401	Credencial ausente, expirada ou malformada (`credential_absent`, `credential_expired`, `credential_malformed`).
402	O Plan ainda não está habilitado para sua organização (`plan_upgrade_required`). É o esperado durante a Beta: escreva para [email protected].
403	Contas de convidado não podem usar o Plan (`guest_not_allowed`).

curl -sS -X POST "https://api.dailybot.com/v1/plan/me/briefing/send-test/?dry_run=true" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

dailybot plan tasks briefing send-test --dry-run

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

Scope: `tasks:write`.
Limite de requisições: 60 escritas por minuto por ator.
Exige uma pessoa: chame com uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal, que age como sua pessoa. Uma key de agente ou da organização recebe `400 actor_required`.

Esta página é a referência de Plan · Notificações e relatórios. Todos os endpoints ficam em https://api.dailybot.com/v1/plan/ e respondem JSON.

Autentique com uma sessão iniciada ou um token de usuário da CLI (Authorization: Bearer …), ou com uma API key (X-API-KEY). Uma API key pessoal age como sua pessoa e pode fazer tudo o que essa pessoa pode fazer no Dailybot; uma key de agente ou da organização nunca age como uma pessoa e é recusada nos endpoints que exigem uma. Em um endpoint, o selo API key significa que uma key de agente ou da organização também é aceita. Veja Autenticação do Plan, Autenticação e Erros para as regras comuns a todas as APIs do Dailybot.

Se é sua primeira vez com o Plan, leia a visão geral para entender o modelo: projetos, quadros, estados, chaves, ordem, versões e arquivamento.

Os endpoints pessoais (me/notifications, me/briefing) exigem uma pessoa: uma sessão iniciada, um token de usuário da CLI ou uma API key pessoal; uma key de agente ou da organização recebe 400 actor_required. Rotas, relatórios agendados e seus envios de teste são para administradores da organização. Todo envio de teste aceita ?dry_run=true, que renderiza e resolve sem enviar. O resumo de uma pessoa sempre chega por mensagem direta e/ou e-mail, nunca em um canal.