Create a task

type

string

enum

required

The task type.

Allowed:

name

string

required

The name of the task.

description

string | null

null is allowed. A longer description of the task.

priority

string

The priority key of the task (for example none, low, medium, high). Defaults to the organization's default priority.

status

string

The status key of the task. Defaults to the organization's initial status (for example to_do).

assigned_to_user_id

uuid | null

The identifier of the user to assign the task to. Assigning anyone but yourself requires the tasks:assign permission.

assigned_to_group_id

uuid | null

The identifier of the user group to assign the task to.

reference_type

string

enum

The type of entity to link the task to.

Allowed:

reference_id

string | null

The entity to link the task to: its ID, or its policy, claim or complaint number. A number is resolved to the entity's ID, and the ID is stored. Requires reference_type. Returns 404 when no entity matches, and 409 when a number matches more than one.

due_date

date-time | null

The date and time by which the task is due. When omitted, it is derived from the priority's SLA.

sla_hours

integer

≥ 1

The number of hours, from creation, within which the task is due.

schedule_id

uuid | null

The identifier of the task schedule this task belongs to. Only API keys may set it; a request from a dashboard user that sets it is refused.

200Success