Skip to main content

​
Task

Represents a task associated with a mention or alert for tracking follow-up actions.
​
id
string
required
Unique identifier for the task
​
title
string
required
Task title or summary
​
description
string
Detailed description of the task
​
status
string
default:"pending"
Current task status: pending, in_progress, completed, or cancelled
​
assigned_to
string
User ID or email of the person assigned to the task
​
due_at
string
ISO 8601 timestamp when the task is due
​
completed_at
string
ISO 8601 timestamp when the task was completed
​
created_at
string
ISO 8601 timestamp when the task was created
​
updated_at
string
ISO 8601 timestamp when the task was last updated
​
mention_id
string
ID of the associated mention, if any
​
alert_id
string
ID of the associated alert, if any
​
account_id
string
ID of the account that owns this task

​
TaskStatus Enum

Available task status values:
  • pending - Task has not been started
  • in_progress - Task is currently being worked on
  • completed - Task has been completed
  • cancelled - Task was cancelled and will not be completed

​
Example

{
  "id": "task_1234567890",
  "title": "Respond to customer inquiry",
  "description": "Customer asked about product features, need to provide detailed response",
  "status": "in_progress",
  "assigned_to": "user_789",
  "due_at": "2026-03-05T17:00:00Z",
  "completed_at": null,
  "created_at": "2026-03-04T08:00:00Z",
  "updated_at": "2026-03-04T09:30:00Z",
  "mention_id": "mention_1234567890",
  "alert_id": "alert_1234567890",
  "account_id": "acc_1234567890"
}

​
Request Models

​
CreateTaskRequest

Used when creating a new task.
​
title
string
required
Task title or summary
​
description
string
Detailed description of the task
​
status
string
default:"pending"
Initial task status
​
assigned_to
string
User ID or email to assign the task to
​
due_at
string
ISO 8601 timestamp for the due date

​
UpdateTaskRequest

Used when updating an existing task. All fields are optional.
​
title
string
Updated task title
​
description
string
Updated task description
​
status
string
Updated task status
​
assigned_to
string
Updated assignee
​
due_at
string
Updated due date

Build docs developers (and LLMs) love

Get started for freeTalk to us