Skip to main content
POST
/
v1
/
tasks
Create Task
curl --request POST \
  --url https://api.example.com/v1/tasks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "assigned_user_ids": [
    "<string>"
  ],
  "created_by_id": "<string>",
  "deadline": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "call_id": "<string>",
  "fax_id": "<string>",
  "assistant_id": "<string>",
  "session_id": "<string>",
  "patient_id": "<string>",
  "status": "pending",
  "priority": "medium",
  "type": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "deadline": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "priority": "<string>",
  "created_by_id": "<string>",
  "company_id": "<string>",
  "version": 123,
  "status": "<string>",
  "call_id": "<string>",
  "fax_id": "<string>",
  "assistant_id": "<string>",
  "session_id": "<string>",
  "patient_id": "<string>",
  "type": "<string>",
  "external_message_ids": {}
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Schema with extra="ignore" to allow additional fields from n8n/integrations

title
string
required

Task title

Minimum string length: 1
description
string
required

Task description

Minimum string length: 1
assigned_user_ids
string[]
required

List of user IDs to assign the task to

Minimum array length: 1
created_by_id
string
required

User ID who is creating the task

deadline
string<date-time>
required

Task deadline

tags
string[] | null

List of tags for categorization

call_id
string | null

Associated call ID

fax_id
string | null

Associated fax ID

assistant_id
string | null

Associated assistant ID

session_id
string | null

Associated session ID

patient_id
string | null

Associated patient ID

status
string
default:pending

Task status: pending, in_progress, completed

priority
string
default:medium

Task priority: low, medium, high, urgent

type
string | null

Task type: vob, general, etc.

Response

Successful Response

Schema for task response.

Returns the created task with all fields.

id
string<uuid>
required
title
string
required
description
string
required
tags
string[]
required
deadline
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
priority
string
required
created_by_id
string
required
company_id
string
required
version
integer
required
status
string
required
call_id
string | null
fax_id
string | null
assistant_id
string | null
session_id
string | null
patient_id
string | null
type
string | null
external_message_ids
External Message Ids · object