Skip to main content
POST
Create task

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_task.

title
string
required

One line stating the work, 1..255 chars. This is what the human reads in the Tasks view.

Required string length: 1 - 255
body
string | null

Free text detail. An agent caller puts the context bundle here: reason, the qualification facts, the trigger - enough to act without re-reading the thread.

conversation_sid
string | null

Thread to anchor the task to (ub_cv_…). Omit for a standalone task, which renders on no inbox surface yet.

Required string length: 18
Pattern: ^ub_cv_
due_at
string | null

ISO 8601 UTC deadline; omit for undated. Due today or earlier (and undated too) surfaces the thread as needs_you right away.

expires_at
string | null

ISO 8601 UTC, after now (422 otherwise): still open then, the sweep cancels the task and it reads as expired. Omit for a month ahead (the default, as for every task the product opens); null for a task that never expires.

assignee_user_sid
string | null

User to own the work (us_mb_…, 18 chars). No server-side default: omit it and the task is unassigned.

Required string length: 18

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required