Skip to content

Comentários da Tarefa ​

Comentários são a conversa dentro de uma tarefa. A API lista os comentários e adiciona novos; editar e excluir comentários é feito no app.

Listar comentários ​

GET /external/v1/tasks/:id/comments

Requer permissão tasks:read. Retorna os comentários da tarefa, do mais antigo para o mais recente.

Adicionar um comentário ​

POST /external/v1/tasks/:id/comments

Requer permissão tasks:write. O autor do comentário é o usuário que criou a chave. Aceita o header Idempotency-Key (veja Idempotência).

Corpo da Requisição ​

CampoTipoObrigatórioDescrição
contentstringSimTexto do comentário (máx. 5000 caracteres)
mentionsstring[]NãoUsuários ativos da conta mencionados no comentário

Parâmetros de Caminho ​

ParâmetroTipoObrigatórioDescrição
idstringSimIdentificador da tarefa (UUID)

Requisição ​

bash
curl --request POST \
  --url "https://app.getraze.com/external/v1/tasks/7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11/comments" \
  --header "Content-Type: application/json" \
  --header "X-API-Key: YOUR_API_KEY" \
  --data '{
    "content": "O cliente pediu para passar a ligação para quinta-feira.",
    "mentions": ["2d19889d-6ff9-4782-8165-32e56bb593c0"]
  }'
javascript
const axios = require('axios');

const taskId = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11';

const response = await axios.post(
  `https://app.getraze.com/external/v1/tasks/${taskId}/comments`,
  {
    content: 'O cliente pediu para passar a ligação para quinta-feira.',
    mentions: ['2d19889d-6ff9-4782-8165-32e56bb593c0']
  },
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);

console.log(response.data);
python
import requests

task_id = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11'

response = requests.post(
    f'https://app.getraze.com/external/v1/tasks/{task_id}/comments',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    json={
        'content': 'O cliente pediu para passar a ligação para quinta-feira.',
        'mentions': ['2d19889d-6ff9-4782-8165-32e56bb593c0']
    }
)

print(response.json())

Resposta ​

POST retorna 201 Created com o comentário; GET retorna um array de comentários em data.

json
{
  "success": true,
  "data": {
    "id": "d288b09a-421f-4869-9251-4767183b37d7",
    "content": "O cliente pediu para passar a ligação para quinta-feira.",
    "author": { "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" },
    "mentions": ["2d19889d-6ff9-4782-8165-32e56bb593c0"],
    "created_at": "2026-10-19T13:38:47.559Z",
    "updated_at": "2026-10-19T13:38:47.559Z"
  }
}

Erros ​

StatusCódigoDescrição
400VALIDATION_ERRORcontent vazio ou longo demais, ou um usuário mencionado que não é usuário ativo da conta
404NOT_FOUNDTarefa não encontrada, ou não visível para o criador da chave

GetRaze - AI-Powered Lead Generation