| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Adiciona um novo comentário a um card específico utilizando seu identificador único (id).
Este endpoint permite registrar observações, anotações, interações ou informações complementares diretamente no histórico do card, facilitando a comunicação e o acompanhamento das atividades relacionadas ao processo.
É recomendado para integrações que necessitam registrar eventos externos, sincronizar interações de sistemas terceiros ou adicionar informações relevantes ao histórico de um card.
Após a execução da requisição, o comentário ficará vinculado ao card informado.
Parâmetros utilizados
id do Card
id do CardIdentificador único do card que receberá o comentário.
O ID deve ser informado diretamente na rota da requisição.
Exemplo:
POST https://api.goalfy.com.br/api/external/v1/cards/12345/commentsNeste exemplo:
12345
Corresponde ao ID do card que receberá o comentário.
Body da Requisição
Campos Utilizados
| Campo | Tipo | Descrição |
|---|---|---|
body | string | Conteúdo textual do comentário que será adicionado ao card |
Exemplo de Body raw
{
"body": "Comentário enviado através da API da Goalfy."
}Exemplo de Resposta
{
"author": {
...
},
"body": "{\"entityMap\":{},\"blocks\":[{\"key\":\"7f36e\",\"text\":\"Teste da API\",\"type\":\"unstyled\",\"depth\":0,\"inlineStyleRanges\":[],\"entityRanges\":[],\"data\":{}}]}",
"createdAt": "2026-06-08T00:00",
"id": "12345",
"updatedAt": "2026-06-08T00:00"
}
Possíveis erros
400 Bad RequestRetornado quando o conteúdo do comentário não foi informado ou possui formato inválido.
404 Not FoundRetornado quando o card informado não existe ou não foi localizado.
401 UnauthorizedRetornado quando o token de autenticação é inválido ou não foi enviado corretamente.
403 ForbiddenRetornado quando o usuário não possui permissão para adicionar comentários ao card informado.
Observações
ImportanteO comentário será registrado diretamente no histórico do card.
- O campo body deve conter o texto que será adicionado como comentário.
- Recomenda-se validar o conteúdo antes do envio para evitar informações incompletas ou incorretas.
- Os comentários adicionados podem ficar visíveis para outros usuários com acesso ao card.
- Dependendo das configurações da organização, a criação do comentário poderá gerar eventos no histórico (logs) do Board.
- O retorno da requisição pode variar conforme as permissões do usuário autenticado.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: