Beta

Create Task

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
POST
/v1/tasks

Adds a Task in a Room (room_id) or for a Business (business_id, expected_business_revision). Status is not_started (default) or recommended. Add why to say why it helps. For many, send tasks (up to 1,000) instead of title; goal makes a new goal for them (goals:write too). All or nothing, one receipt; returns task_ids in order. A refused Task: details.task_index.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Header Parameters

SMB-Workspace-Id*string

Workspace where this operation runs. Required for user tokens and Workspace API keys.

Formatuuid
Idempotency-Key*string
Length8 <= length <= 200

Request Body

application/json
  1. body
business_id?SmbV0OperationsSetWorkspaceFieldValueRequestBusinessId
Match^biz_[0-7][0-9A-HJKMNP-TV-Z]{25}$
room_id*string
Match^rom_[0-7][0-9A-HJKMNP-TV-Z]{25}$
expected_business_revision?integer
Range1 <= value
goal_id?|
Match^gol_[0-7][0-9A-HJKMNP-TV-Z]{25}$
title?string
Length1 <= length <= 300
description?|
Lengthlength <= 10000
status?string

recommended suggests it to someone; not_started is the default.

Value in"recommended""not_started"
why?|

Why this Task helps (shown as Why).

Match\S
Length1 <= length <= 2000
assignee_user_id?|
Match^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
assignee_email?|
Formatemail
assignee_rule?|

Room tasks: link_opener = whoever opens a link that starts from this Room. Not with an assignee.

Value in"link_opener"null
due_at?|
Formatdate-time
upload_folder_id?|

Room tasks: folder for its uploads.

Match^rfd_[0-7][0-9A-HJKMNP-TV-Z]{25}$
visibility?string

Room tasks: who sees it (default inherit).

Value in"only_me""people""workspace""room""inherit"
goal?
tasks?array<>

1 to 1,000 Tasks, created in this order.

Items1 <= items <= 1000

Response Body

The existing resource or idempotent replay was returned.

application/json
  1. response
data*|
receipt*
idempotent_replay*smb_v0_operations_create_list_request.__local.properties.body.__schema16
request_id*string
curl -X POST 'https://example.com/v1/tasks' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: stringst' \  -H 'Content-Type: application/json' \  -d '{}'
{  "data": {    "task_id": "string",    "business_id": "string",    "room_id": "string",    "goal_id": "string",    "upload_folder_id": "string",    "title": "string",    "description": "string",    "status": "recommended",    "created_by": {      "type": "user",      "id": "string"    },    "why": "string",    "source": {      "type": "user",      "id": "string"    },    "assignee_user_id": "string",    "assignee_email": "user@example.com",    "assignee_rule": "link_opener",    "due_at": "2019-08-24T14:15:22Z",    "started_at": "2019-08-24T14:15:22Z",    "done_at": "2019-08-24T14:15:22Z",    "archived_at": "2019-08-24T14:15:22Z",    "archive_reason": "string",    "done_with": [      null    ],    "revision": 1,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "receipt": {    "receipt_id": "64d0a161-468e-472a-b00e-a06ee9ab7de7",    "command_id": "7d510d78-7444-4252-aeac-9e473949661e",    "operation": "string",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"  },  "idempotent_replay": true,  "request_id": "string"}