Skip to content

Task Comments ​

Comments are the conversation inside a task. The API lists them and adds new ones; comments are edited and deleted in the app.

List comments ​

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

Requires tasks:read permission. Returns the comments of the task, oldest first.

Add a comment ​

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

Requires tasks:write permission. The comment is authored by the user who created the API key. Accepts an Idempotency-Key header (see Idempotency).

Request Body ​

FieldTypeRequiredDescription
contentstringYesComment text (max 5000 characters)
mentionsstring[]NoActive users of the account mentioned in the comment

Path Parameters ​

ParameterTypeRequiredDescription
idstringYesTask identifier (UUID)

Request ​

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": "Client asked to move the call to Thursday.",
    "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: 'Client asked to move the call to Thursday.',
    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': 'Client asked to move the call to Thursday.',
        'mentions': ['2d19889d-6ff9-4782-8165-32e56bb593c0']
    }
)

print(response.json())

Response ​

POST returns 201 Created with the comment; GET returns an array of comments in data.

json
{
  "success": true,
  "data": {
    "id": "d288b09a-421f-4869-9251-4767183b37d7",
    "content": "Client asked to move the call to Thursday.",
    "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"
  }
}

Errors ​

StatusCodeDescription
400VALIDATION_ERROREmpty or too long content, or a mentioned user that is not an active user of the account
404NOT_FOUNDTask not found, or not visible to the key's creator

GetRaze - AI-Powered Lead Generation