SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
tasks

Post a comment or a threaded reply. Mentions are stored as rows and notify from those rows.

Post a comment or a threaded reply. Mentions are stored as rows and notify from those rows.

POSThttps://app.softsolz.uk/api/v1/services/tasks/tasks/{id}/comments

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Body Params

bodystring

The comment text.

assignment_idinteger

Omit for task-level discussion; set for the private reviewer-to-assignee thread.

parent_comment_idinteger

The comment being replied to.

mentionsarray of integers

User ids mentioned.

Response

Response Body

idintegerComment id.
task_idintegerTask the comment belongs to.
assignment_idinteger | nullNull means task-level and visible to everyone on the task. Set means the private thread between one assignee and their reviewers.
parent_comment_idinteger | nullThe comment this replies to.
author_idinteger | nullWho wrote it.
bodystringThe comment text.
mentionsarray of integersUser ids mentioned. Stored as rows when the comment is written, never re-parsed from the text.
created_atstringWhen.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.tasks.createTaskComment('<id>', {});
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 201

{
"data": {
"id": 0,
"task_id": 0,
"assignment_id": 0,
"parent_comment_id": 0,
"author_id": 0,
"body": "string",
"mentions": [],
"created_at": "string"
}
}