Create Task

Create a task. Retrying with the same Idempotency-Key returns the first response.

POST /api/v1/tasks

Create Task

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/tasks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "<string>",
  "priority": "<string>",
  "deadline": "2023-12-25",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "links": [
    {
      "target_type": "conversation",
      "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'

201

{
  "id": "<string>",
  "title": "<string>",
  "status": {
    "key": "<string>",
    "label": "<string>",
    "category": "<string>",
    "role": "<string>"
  },
  "priority": "<string>",
  "labels": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>"
    }
  ],
  "links": [
    {
      "id": "<string>",
      "target_type": "<string>",
      "target_id": "<string>",
      "context": {
        "conversation_id": "<string>",
        "message_id": "<string>"
      },
      "deleted": true,
      "admin_url": "<string>"
    }
  ],
  "source": "<string>",
  "revision": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "admin_url": "<string>",
  "identifier": "<string>",
  "description": "",
  "deadline": "2023-12-25",
  "owner": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "created_by": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "finished_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Headers

Idempotency-Key · string | null

Body

application/json

title · string · required

Maximum string length: 200

description · string | null

Maximum string length: 5000

status · string | null

Status key or id. Defaults to the first to-do status.

priority · string | null

none, low, normal, high, or urgent

deadline · string<date> | null

owner_id · string<uuid> | null

An active staff member. Omit to leave unowned.

label_ids · string<uuid>[]

links · TaskLinkIn · object[]

Maximum array length: 10

Show child attributes

Response

201 - application/json

Created

id · string · required

title · string · required

status · TaskStatusRef · object · required

Show child attributes

priority · string · required

labels · TaskLabelOut · object[] · required

Show child attributes

links · TaskLinkOut · object[] · required

Show child attributes

source · string · required

revision · integer · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

admin_url · string · required

identifier · string | null

Short handle such as TASK-12, accepted wherever a task id is.

description · string · default: ""

deadline · string<date> | null

owner · TaskUserRef · object | null

Show child attributes

created_by · TaskUserRef · object | null

Show child attributes

finished_at · string<date-time> | null

archived_at · string<date-time> | null