Create a task

POST

/api/v1/tasks

Create a new task for the account team. The task appears in the dashboard inbox in the open state.

Use cases

• Knowledge suggestions: Record a suggestion to add or improve knowledge content
• Follow-ups: Log something a human needs to review or act on after an automated investigation

Notes

• name, description, type and source are required
• Use the data field for structured context the assignee needs

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Request Body ^required

object

name

required

Short title of the task.

string

description

required

Longer explanation of what the task is about.

string

type

required

The kind of work this task represents.

string

Allowed values: knowledge-suggestion knowledge-gap-detected review-flagged-conversation new-sales-opportunity retention-warning sales-expansion-opportunity wiki-suggestion maturity-task

source

required

Where the task originated.

string

Allowed values: team-assistant ai dashboard ingestion slack

data

Optional structured payload attached to the task.

object

Responses

200

The created task.

object

task

object

accountId

The account ID that owns this task.

string

taskId

Unique identifier for this task.

string

name

Short title of the task.

string

description

Longer explanation of what the task is about.

string

nullable

type

The kind of work this task represents.

string

Allowed values: knowledge-suggestion knowledge-gap-detected review-flagged-conversation new-sales-opportunity retention-warning sales-expansion-opportunity wiki-suggestion maturity-task

source

Where the task originated.

string

Allowed values: team-assistant ai dashboard ingestion slack

state

Current state of the task.

string

Allowed values: open done deleted

data

Arbitrary structured payload attached to the task, depends on the task type.

object

assignee

Email address of the user the task is assigned to.

string

nullable

websiteId

The website this task belongs to.

string

nullable

createdAt

Unix timestamp (ms) when the task was created.

number

updatedAt

Unix timestamp (ms) when the task was last updated.

number

400

Bad request - missing required fields.

401

Unauthorized - invalid API key.