Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsAdd Task Comment
Search the full API reference Esc to close

Add Task Comment

Tasks · REST API reference

Get support
POST/v1/tasks/{task_id}/comments
Add one comment to a task's thread and answer the new entry.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/tasks/<TASK_ID>/comments' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "body": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

task_idpath · stringrequired

Format: uuid

Request body

application/json · Required

bodystringrequired

The comment. Surrounding whitespace is removed, and it cannot be blank.

Min length: 1 · Max length: 2000

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

201Successful Response
JSON · generated example
{
  "data": {
    "actor": {
      "display_name": "string",
      "id": "00000000-0000-4000-8000-000000000001"
    },
    "body": "string",
    "created_at": "2026-10-29T12:00:00Z",
    "id": "00000000-0000-4000-8000-000000000001",
    "kind": "string",
    "target_user": {
      "display_name": "string",
      "id": "00000000-0000-4000-8000-000000000001"
    }
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataTaskActivityResponserequired

One entry of a task's thread on the wire.

Show data schema
actorPersonResponserequired

A user, as a task or a thread entry names one.

Show actor schema
display_namestringrequired

The name to show for the user.

idstringrequired

The user's id.

Format: uuid

bodystringrequired

The comment's text, or the sentence the server wrote for an entry of any other kind. Never null.

created_atstringrequired

When the entry was written.

Format: date-time

idstringrequired

Unique identifier for this thread entry.

Format: uuid

kindstringrequired

comment, status_change, assignment, photo_upload, note_pinned, reopened, adopted or system.

target_userPersonResponse | null

The person an assignment entry names. Null on every other entry, and on an unassign.

Show target_user schema
PersonResponse | null

The person an assignment entry names. Null on every other entry, and on an unassign.

Variant 1: PersonResponse
display_namestringrequired

The name to show for the user.

idstringrequired

The user's id.

Format: uuid

Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll tasks operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Add Task Comment | Facily Developers