English
Appearance
Comments are the conversation inside a task. The API lists them and adds new ones; comments are edited and deleted in the app.
/external/v1/tasks/:id/comments
Requires tasks:read permission. Returns the comments of the task, oldest first.
tasks:read
Requires tasks:write permission. The comment is authored by the user who created the API key. Accepts an Idempotency-Key header (see Idempotency).
tasks:write
Idempotency-Key
content
mentions
id
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"] }'
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);
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())
POST returns 201 Created with the comment; GET returns an array of comments in data.
POST
201 Created
GET
data
{ "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" } }
VALIDATION_ERROR
NOT_FOUND
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/commentsRequires
tasks:readpermission. Returns the comments of the task, oldest first.Add a comment
POST/external/v1/tasks/:id/commentsRequires
tasks:writepermission. The comment is authored by the user who created the API key. Accepts anIdempotency-Keyheader (see Idempotency).Request Body
contentmentionsPath Parameters
idRequest
Response
POSTreturns201 Createdwith the comment;GETreturns an array of comments indata.Errors
VALIDATION_ERRORcontent, or a mentioned user that is not an active user of the accountNOT_FOUND